Capabilities

Available hosting methods

Choose the hosting method that best suits your needs:

Gather Retool credentials

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

A user with the ability to create a new user in Retool must perform this task.

Create a Retool user and compose the connection string

1. Connect to the Retool database and create a new user. The connector will use this user to connect to the PostGreSQL database. Make sure to create and save a secure password:

   CREATE USER baton WITH PASSWORD 'secure-password';

2. Grant the new user the following privileges, which are required by the connector for inspecting Retool privileges:

   GRANT SELECT ("id", "name", "organizationId", "universalAccess", "universalResourceAccess", "universalQueryLibraryAccess", "userListAccess", "auditLogAccess", "unpublishedReleaseAccess") ON groups TO baton;
   GRANT SELECT, INSERT, UPDATE ("id", "accessLevel"), DELETE ON group_pages TO baton;
   GRANT SELECT, INSERT, UPDATE ("id", "accessLevel") ON group_folder_defaults TO baton;
   GRANT SELECT, INSERT, UPDATE ("id", "accessLevel") on group_resources TO baton;
   GRANT SELECT, INSERT, UPDATE ("id", "accessLevel") on group_resource_folder_defaults TO baton;
   GRANT SELECT ("id", "name") ON organizations TO baton;
   GRANT SELECT ("id", "name", "organizationId", "folderId", "photoUrl", "description", "deletedAt") ON pages TO baton;
   GRANT SELECT ("id", "name", "organizationId", "type", "displayName", "environmentId", "resourceFolderId") ON resources TO baton;
   GRANT SELECT ("id", "email", "firstName", "lastName", "profilePhotoUrl", "userName", "enabled", "lastLoggedIn", "organizationId") ON users TO baton;
   GRANT SELECT, INSERT, UPDATE, DELETE ("id", "userId", "groupId", "isAdmin", "updatedAt") ON user_groups TO baton;
   GRANT USAGE, SELECT ON SEQUENCE user_groups_id_seq TO baton;
   GRANT DELETE ON user_groups TO baton;
   

3. Compose and save the Retool connection string you’ll use when setting up the connector. This string will be in this form:

   "user=baton password=secure-password host=localhost port=5432 dbname=hammerhead_production"

That’s it! Next, move on to the instructions for your chosen setup method.

Set up a Retool self-hosted connector

To complete this task, you’ll need:

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

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

Why use Kubernetes? Kubernetes provides automated deployment, scaling, and management of your connectors. It ensures high availability and reliable operation of your connector services.

Step 1: Configure the Retool connector

1. In ConductorOne, navigate to Connectors > Add connector.

2. Search for Baton and click Add.

3. Choose how to set up the new Retool connector:

   • Add the connector to a currently unmanaged app (select from the list of apps that were discovered in your identity, SSO, or federation provider that aren’t yet managed with ConductorOne)

   • Add the connector to a managed app (select from the list of existing managed apps)

   • Create a new managed app

4. Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of ConductorOne users. Setting multiple owners is allowed.

   If you choose someone else, ConductorOne will notify the new connector owner by email that their help is needed to complete the setup process.

5. Click Next.

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

7. 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 Retool connector deployment:

Secrets configuration

# baton-retool-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
  name: baton-retool-secrets
type: Opaque
stringData:
  # ConductorOne credentials
  BATON_CLIENT_ID: <ConductorOne client ID>
  BATON_CLIENT_SECRET: <ConductorOne client secret>
  
  # Retool credentials
  BATON_CONNECTION_STRING: <The Retool connection string, in format "user=baton password=secure-password host=localhost port=5432 dbname=hammerhead_production">

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

Deployment configuration

# baton-retool.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: baton-retool
  labels:
    app: baton-retool
spec:
  selector:
    matchLabels:
      app: baton-retool
  template:
    metadata:
      labels:
        app: baton-retool
        baton: true
        baton-app: retool
    spec:
      containers:
      - name: baton-retool
        image: ghcr.io/conductorone/baton-retool:latest
        imagePullPolicy: IfNotPresent
        envFrom:
        - secretRef:
            name: baton-retool-secrets

Step 3: Deploy the connector

1. Create a namespace in which to run ConductorOne connectors (if desired):

   kubectl create namespace conductorone
   

2. Apply the secret configuration:

   kubectl -n conductorone apply -f baton-retool-secrets.yaml
   

3. Apply the deployment:

   kubectl -n conductorone apply -f baton-retool.yaml
   

Step 4: Verify the deployment

1. Check that the deployment is running:

   kubectl -n conductorone get pods
   

2. View the connector logs:

   kubectl -n conductorone logs -l app=baton-${baton-retool}
   

3. Check that the connector data uploaded correctly. In ConductorOne, click Applications. On the Managed apps tab, locate and click the name of the application you added the Retool connector to. Retool data should be found on the Entitlements and Accounts tabs.

That’s it! Your Retool connector is now pulling access data into ConductorOne.