Set up a CouchDB connector

C1 provides identity governance for CouchDB. Integrate your CouchDB instance with C1 for unified visibility and governance over user access.

This connector is in beta. This means it’s undergoing ongoing testing and development while we gather feedback, validate functionality, and improve stability. Beta connectors are generally stable, but they may have limited feature support, incomplete error handling, or occasional issues.

We recommend closely monitoring workflows that use this connector and contacting our Support team with any issues or feedback.

Capabilities

Resource	Sync	Provision
Accounts
Roles
Databases

Gather CouchDB credentials

Each setup method requires you to pass in credentials generated in CouchDB. Gather these credentials before you move on.

1. The username and password for your CouchDB account, or for a service account you’ve set up.

2. The URL, including port number, of your CouchDB tenant (for example: https://couchdb.example.com:5984).

Done. Next, move on to the connector configuration instructions.

Configure the CouchDB connector

To complete this task, you’ll need:

• The Connector Administrator or Super Administrator role in C1
• Access to the set of CouchDB credentials generated by following the instructions above

Cloud-hosted

Follow these instructions to use a built-in, no-code connector hosted by C1.

1. In C1, navigate to Apps > Connectors and click Add connector.

2. Search for CouchDB and click Add.

3. Choose where to add the connector: Create a new app, or Add to an existing app (then select the app).

   If you’re creating a new app, choose whether to link it to an application discovered from your identity provider: select Yes and pick the IdP application, or No to continue with just the connector.

4. Set the connector’s Name and, optionally, a Description.

5. Click the pencil icon next to Owners to choose who can configure and manage this connector.

6. Click Add. The connector is created and its configuration page opens.

7. Find the Settings area of the page and click Edit.

8. Enter the URL, including port number, of your CouchDB tenant in the Instance URL field.

9. Enter the username and password of a CouchDB account in the Username and Password fields.

10. Click Save.

11. The connector’s label changes to Syncing, followed by Connected. You can view the logs to ensure that information is syncing.

Done. Your CouchDB connector is now pulling access data into C1.

Self-hosted

Follow these instructions to use the CouchDB connector, hosted and run in your own environment.

When running in service mode on Kubernetes, a self-hosted connector maintains an ongoing connection with C1, automatically syncing and uploading data at regular intervals. This data is immediately available in the C1 UI for access reviews and access requests.

Resources

• GitHub repository: Access the source code, report issues, or contribute to the project.

Step 1: Configure the CouchDB connector

1. In C1, navigate to Apps > Connectors and click Add connector.

2. Search for Baton and click Add.

3. Choose where to add the connector: Create a new app, or Add to an existing app (then select the app).

   If you’re creating a new app, choose whether to link it to an application discovered from your identity provider: select Yes and pick the IdP application, or No to continue with just the connector.

4. Set the connector’s Name and, optionally, a Description.

5. Click the pencil icon next to Owners to choose who can configure and manage this connector.

6. Click Add. The connector is created and its configuration page opens.

7. In the Settings area of the page, click Edit.

8. Click Rotate to generate a new Client ID and Secret.

   Carefully copy and save these credentials. We’ll use them in Step 2.

Step 2: Create Kubernetes configuration files

Create two Kubernetes manifest files for your CouchDB connector deployment:

Secrets configuration

# baton-couchdb-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-couchdb-secrets
type: Opaque
stringData:
  # C1 credentials
  BATON_CLIENT_ID: <C1 client ID>
  BATON_CLIENT_SECRET: <C1 client secret>
  
  # CouchDB credentials
  BATON_USERNAME: <CouchDB account username>
  BATON_PASSWORD: <CouchDB account password>
  BATON_INSTANCE_URL: <URL, including port, of the CouchDB instance>

See the connector’s README or run --help to see all available configuration flags and environment variables.

Deployment configuration

# baton-couchdb.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: baton-couchdb
  labels:
    app: baton-couchdb
spec:
  selector:
    matchLabels:
      app: baton-couchdb
  template:
    metadata:
      labels:
        app: baton-couchdb
        baton: "true"
        baton-app: couchdb
    spec:
      containers:
      - name: baton-couchdb
        image: public.ecr.aws/conductorone/baton-couchdb:latest
        imagePullPolicy: IfNotPresent
        env:
        - name: BATON_HOST_ID
          value: baton-couchdb
        envFrom:
        - secretRef:
            name: baton-couchdb-secrets

Step 3: Deploy the connector

1. Create a namespace in which to run C1 connectors (if desired), then apply the secret config and deployment config files.

2. Check that the connector data uploaded correctly. In C1, click Apps. On the Managed apps tab, locate and click the name of the application you added the CouchDB connector to. CouchDB data should be found on the Entitlements and Accounts tabs.

Done. Your CouchDB connector is now pulling access data into C1.