Skip to content

Commit 19975cc

Browse files
author
baton-admin[bot]
committed
docs: seed connector documentation from ConductorOne/docs
1 parent 1dab2fa commit 19975cc

File tree

1 file changed

+224
-0
lines changed

1 file changed

+224
-0
lines changed

‎docs/connector.mdx‎

Lines changed: 224 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,224 @@
1+
---
2+
title: "Set up a Fastly connector"
3+
og:title: "Set up a Fastly connector"
4+
description: "ConductorOne provides identity governance and just-in-time provisioning for Fastly. Integrate your Fastly instance with ConductorOne to run user access reviews (UARs) and enable just-in-time access requests."
5+
og:description: "ConductorOne provides identity governance and just-in-time provisioning for Fastly. Integrate your Fastly instance with ConductorOne to run user access reviews (UARs) and enable just-in-time access requests."
6+
sidebarTitle: "Fastly"
7+
---
8+
9+
## Capabilities
10+
11+
| Resource | Sync | Provision |
12+
| :--- | :--- | :--- |
13+
| Accounts | <Icon icon="square-check" iconType="solid" color="#65DE23"/> | |
14+
| Roles | <Icon icon="square-check" iconType="solid" color="#65DE23"/> | <Icon icon="square-check" iconType="solid" color="#65DE23"/> |
15+
| Services | <Icon icon="square-check" iconType="solid" color="#65DE23"/> | <Icon icon="square-check" iconType="solid" color="#65DE23"/> |
16+
17+
## Gather Fastly credentials
18+
19+
Configuring the connector requires you to pass in credentials generated in Fastly. Gather these credentials before you move on.
20+
21+
<Warning>
22+
A user with the **Superuser** role in Fastly must perform this task.
23+
</Warning>
24+
25+
### Create a Fastly automation API token
26+
27+
<Steps>
28+
<Step>
29+
In Fastly, click on your account name in the top navigation bar and select **Account**.
30+
</Step>
31+
<Step>
32+
Click **API tokens**.
33+
</Step>
34+
<Step>
35+
Click **Create Token**.
36+
</Step>
37+
<Step>
38+
On the **Create a Token** page, give the new API token a name (such as "ConductorOne").
39+
</Step>
40+
<Step>
41+
In the **Type** area of the page, select **Automation token** and fill out the form as follows:
42+
- Role: Select **Engineer**
43+
- TLS management: leave the box unchecked
44+
- Scope: Select **Read-only access**
45+
- Access: Select the relevant services or all services, as appropriate
46+
- Expiration: If you set an expiration date, remember that the connection with ConductorOne will fail if the token expires.
47+
</Step>
48+
<Step>
49+
Click **Create Token**.
50+
</Step>
51+
<Step>
52+
The new token is generated. Carefully copy and save the token.
53+
</Step>
54+
</Steps>
55+
56+
**That's it!** Next, move on to the connector configuration instructions.
57+
58+
## Configure the Fastly connector
59+
60+
<Warning>
61+
To complete this task, you'll need:
62+
63+
- The **Connector Administrator** or **Super Administrator** role in ConductorOne
64+
- Access to the set of Fastly credentials generated by following the instructions above
65+
</Warning>
66+
67+
<Tabs>
68+
<Tab title="Cloud-hosted">
69+
**Follow these instructions to use a built-in, no-code connector hosted by ConductorOne.**
70+
71+
<Steps>
72+
<Step>
73+
In ConductorOne, navigate to **Integrations** > **Connectors** and click **Add connector**.
74+
</Step>
75+
<Step>
76+
Search for **Fastly** and click **Add**.
77+
</Step>
78+
<Step>
79+
Choose how to set up the new Fastly connector:
80+
- 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)
81+
- Add the connector to a managed app (select from the list of existing managed apps)
82+
- Create a new managed app
83+
</Step>
84+
<Step>
85+
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.
86+
87+
If you choose someone else, ConductorOne will notify the new connector owner by email that their help is needed to complete the setup process.
88+
</Step>
89+
<Step>
90+
Click **Next**.
91+
</Step>
92+
<Step>
93+
Find the **Settings** area of the page and click **Edit**.
94+
</Step>
95+
<Step>
96+
Paste the automation API token into the **API token** field.
97+
</Step>
98+
<Step>
99+
Click **Save**.
100+
</Step>
101+
<Step>
102+
The connector's label changes to **Syncing**, followed by **Connected**. You can view the logs to ensure that information is syncing.
103+
</Step>
104+
</Steps>
105+
106+
**That's it!** Your Fastly connector is now pulling access data into ConductorOne.
107+
108+
</Tab>
109+
<Tab title="Self-hosted">
110+
**Follow these instructions to use the Fastly connector, hosted and run in your own environment.**
111+
112+
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.
113+
114+
### Resources
115+
116+
* [GitHub repository](https://github.com/ConductorOne/baton-fastly): Access the source code, report issues, or contribute to the project.
117+
118+
### Step 1: Set up a new Fastly connector
119+
120+
<Steps>
121+
<Step>
122+
In ConductorOne, navigate to **Integrations** > **Connectors** > **Add connector**.
123+
</Step>
124+
<Step>
125+
Search for **Baton** and click **Add**.
126+
</Step>
127+
<Step>
128+
Choose how to set up the new Fastly connector:
129+
- 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)
130+
- Add the connector to a managed app (select from the list of existing managed apps)
131+
- Create a new managed app
132+
</Step>
133+
<Step>
134+
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.
135+
136+
If you choose someone else, ConductorOne will notify the new connector owner by email that their help is needed to complete the setup process.
137+
</Step>
138+
<Step>
139+
Click **Next**.
140+
</Step>
141+
<Step>
142+
In the **Settings** area of the page, click **Edit**.
143+
</Step>
144+
<Step>
145+
Click **Rotate** to generate a new Client ID and Secret.
146+
147+
Carefully copy and save these credentials. We'll use them in Step 2.
148+
</Step>
149+
</Steps>
150+
151+
### Step 2: Create Kubernetes configuration files
152+
153+
Create two Kubernetes manifest files for your Fastly connector deployment:
154+
155+
#### Secrets configuration
156+
157+
```yaml expandable
158+
# baton-fastly-secrets.yaml
159+
apiVersion: v1
160+
kind: Secret
161+
metadata:
162+
name: baton-fastly-secrets
163+
type: Opaque
164+
stringData:
165+
# ConductorOne credentials
166+
BATON_CLIENT_ID: <ConductorOne client ID>
167+
BATON_CLIENT_SECRET: <ConductorOne client secret>
168+
169+
# Fastly credentials
170+
BATON_ACCESS_TOKEN: <Fastly API token>
171+
```
172+
173+
See the connector's README or run `--help` to see all available configuration flags and environment variables.
174+
175+
#### Deployment configuration
176+
177+
```yaml expandable
178+
# baton-fastly.yaml
179+
apiVersion: apps/v1
180+
kind: Deployment
181+
metadata:
182+
name: baton-fastly
183+
labels:
184+
app: baton-fastly
185+
spec:
186+
selector:
187+
matchLabels:
188+
app: baton-fastly
189+
template:
190+
metadata:
191+
labels:
192+
app: baton-fastly
193+
baton: true
194+
baton-app: fastly
195+
spec:
196+
containers:
197+
- name: baton-fastly
198+
image: ghcr.io/conductorone/baton-fastly:latest
199+
imagePullPolicy: IfNotPresent
200+
env:
201+
- name: BATON_HOST_ID
202+
value: baton-fastly
203+
envFrom:
204+
- secretRef:
205+
name: baton-fastly-secrets
206+
```
207+
208+
### Step 3: Deploy the connector
209+
210+
<Steps>
211+
<Step>
212+
Create a namespace in which to run ConductorOne connectors (if desired), then apply the secret config and deployment config files.
213+
</Step>
214+
<Step>
215+
Check that the connector data uploaded correctly. In ConductorOne, click **Apps**. On the **Managed apps** tab, locate and click the name of the application you added the Fastly connector to. Fastly data should be found on the **Entitlements** and **Accounts** tabs.
216+
</Step>
217+
</Steps>
218+
219+
**That's it!** Your Fastly connector is now pulling access data into ConductorOne.
220+
221+
</Tab>
222+
</Tabs>
223+
224+

0 commit comments

Comments
 (0)