You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/public/03-configuration-reference.md
+12Lines changed: 12 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,6 +71,9 @@ spec:
71
71
userName:
72
72
secretName: example-agent-connection-secret
73
73
secretKey: userName
74
+
token:
75
+
secretName: example-agent-connection-secret
76
+
secretKey: token
74
77
```
75
78
76
79
| Property | Type | Required | Default Value | Description |
@@ -82,8 +85,12 @@ spec:
82
85
| spec.serviceKey.secretKey | string | Yes | | The key of the value in the named Secret containing the serviceKey. |
83
86
| spec.userName.secretName | string | Yes | | The name of the Secret containing the userName. |
84
87
| spec.userName.secretKey | string | Yes | | The key of the value in the named Secret containing the userName. |
88
+
| spec.token.secretName | string | Yes | | The name of the Secret containing the token. |
89
+
| spec.token.secretKey | string | Yes | | The key of the value in the named Secret containing the token. |
85
90
86
91
- For security, Secrets referenced must be contained in the same namespace as the AgentConnection.
92
+
- Either (`url`, `apiKey`, `serviceKey`, `userName`) or `token` should be used, not both. The Agent Token is a base64 encoded JSON object containing the url, api_key, service_key, and user_name configuration settings, allowing you to set them in a single value.
93
+
- Minimum agent version for token support is: java 6.10.1, dotnet-core 4.3.2, nodejs 5.15.0, python 8.6.0, php 1.34.0
87
94
88
95
## AgentInjector
89
96
@@ -205,6 +212,9 @@ spec:
205
212
userName:
206
213
secretName: default-agent-connection-secret
207
214
secretKey: userName
215
+
token:
216
+
secretName: example-agent-connection-secret
217
+
secretKey: token
208
218
```
209
219
210
220
| Property | Type | Required | Default Value | Description |
@@ -214,3 +224,5 @@ spec:
214
224
215
225
- For security, ClusterAgentConnection manifests must be deployed into the same namespace of the operator.
216
226
- Secrets referenced by ClusterAgentConnection must exist in the same namespace in which the ClusterAgentConnection entity is deployed.
227
+
- Either (`url`, `apiKey`, `serviceKey`, `userName`) or `token` should be used, not both. The Agent Token is a base64 encoded JSON object containing the url, api_key, service_key, and user_name configuration settings, allowing you to set them in a single value.
228
+
- Minimum agent version for token support is: java 6.10.1, dotnet-core 4.3.2, nodejs 5.15.0, python 8.6.0, php 1.34.0
Copy file name to clipboardExpand all lines: docs/public/setup/02-configuration.md
+33Lines changed: 33 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,3 +67,36 @@ spec:
67
67
```
68
68
69
69
In this example manifest, the Contrast Agent Operator will automatically inject the .NET Contrast agent into workloads (e.g. Deployments, DeploymentConfigs, etc.) that have the label `app=dotnet-hello-world` in the namespace `default`.
70
+
71
+
72
+
## Agent Token auth configuration
73
+
74
+
The Agent Token is a base64 encoded JSON object containing the url, api_key, service_key, and user_name configuration settings, allowing you to set them in a single value. The minimum agent version for token support is: java 6.10.1, dotnet-core 4.3.2, nodejs 5.15.0, python 8.6.0, php 1.34.0
75
+
76
+
77
+
```yaml
78
+
apiVersion: v1
79
+
kind: Secret
80
+
metadata:
81
+
name: default-agent-connection-secret
82
+
namespace: contrast-agent-operator
83
+
type: Opaque
84
+
stringData:
85
+
token: TODO
86
+
```
87
+
88
+
> Finding your token is documented in the "[Find the agent keys](https://docs.contrastsecurity.com/en/find-the-agent-keys.html)" section.
0 commit comments