Set up a Teleport connector
Capabilities
Resource | Sync | Provision |
---|---|---|
Accounts | ✅ | |
Roles | ✅ | |
Nodes | ✅ | |
Apps | ✅ | |
Databases | ✅ |
Gather Teleport credentials
Configuring the connector requires you to pass in credentials generated in Teleport. Gather these credentials before you move on.
Generate an identity file
Follow this process to set up a local Teleport instance and generate an auth.pem
identity file. You can follow other procedures to generate the auth.pem
file: see the baton-teleport README for instructions.
Install Teleport:
curl https://goteleport.com/static/install.sh | bash -s 15.1.4
Add a Teleport .yaml file. Replace <email_account> and <cluster_name> with your cluster credentials and add the port number (:443) to your cluster name.
sudo teleport configure -o file \ --acme --acme-email=<email_account> \ --cluster-name=<cluster_name>
Log your Teleport cluster:
tsh login --proxy=<cluster_name> --user=<email_account> TELEPORT_CONFIG_FILE="" tctl status
Start Teleport, using the .yaml file:
sudo teleport start --config="/etc/teleport.yaml"
Generate an invitation token with roles for the host. The invitation token is required for the local computer to join the cluster.
TELEPORT_CONFIG_FILE="" tctl tokens add --type=user,role,node,app,db
You’ll receive an output that looks like this:
teleport start \ --roles=node \ `--token=dd5f637d11e94c3fb2ed3516b9482e74` \ `--ca-pin=sha256:5fc6849caaf45eb70fb564224b727dbce31a32f2a8329910fcebc84aaaee7160` \ --auth-server=baton-conductorone.teleport.sh:443
Open the Teleport configuration file
/etc/teleport.yaml
in an editor on the computer where you installed the Teleport agent and replacetoken
andca-pin
with the values from the invitation token.Stop and restart Teleport:
sudo teleport start --config="/etc/teleport.yaml"
Finally, generate an
auth.pem
identity file using thetctl admin
tool:TELEPORT_CONFIG_FILE="" tctl auth sign --ttl=8h --user=<email_account> --out=auth.pem
Save the
auth.pem
file and make a note of the file path.
That’s it! Next, move on to the connector configuration instructions.
Configure the Teleport connector
To complete this task, you’ll need:
- The Connector Administrator or Super Administrator role in ConductorOne
Follow these instructions to use a built-in, no-code connector hosted by ConductorOne.
Teleport does not support a cloud-hosted connector.
Follow these instructions to use the Teleport connector, hosted and run in your own environment.
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.
Step 1: Configure the Teleport connector
In ConductorOne, navigate to Connectors > Add connector.
Search for Baton and click Add.
Choose how to set up the new Teleport 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
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.
Click Next.
In the Settings area of the page, click Edit.
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 Teleport connector deployment:
Secrets configuration
# baton-teleport-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
name: baton-teleport-secrets
type: Opaque
stringData:
# ConductorOne credentials
BATON_CLIENT_ID: <ConductorOne client ID>
BATON_CLIENT_SECRET: <ConductorOne client secret>
# Teleport credentials
BATON_TELEPORT_KEY_PATH: <Path to the auth.pm Teleport file>
BATON_TELEPORT_PROXY_ADDRESS: <Fully qualified address of your Teleport proxy service>
See the connector’s README or run --help
to see all available configuration flags and environment variables.
Deployment configuration
# baton-teleport.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: baton-teleport
labels:
app: baton-teleport
spec:
selector:
matchLabels:
app: baton-teleport
template:
metadata:
labels:
app: baton-teleport
baton: true
baton-app: teleport
spec:
containers:
- name: baton-teleport
image: ghcr.io/conductorone/baton-teleport:latest
imagePullPolicy: IfNotPresent
envFrom:
- secretRef:
name: baton-teleport-secrets
Step 3: Deploy the connector
Create a namespace in which to run ConductorOne connectors (if desired), then apply the secret config and deployment config files.
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 Teleport connector to. Teleport data should be found on the Entitlements and Accounts tabs.
That’s it! Your Teleport connector is now pulling access data into ConductorOne.