Skip to content

Commit 9a877ab

Browse files
authored
updated readme and nozzle manifest with client creds updates(#203)
1 parent e671b62 commit 9a877ab

File tree

2 files changed

+21
-15
lines changed

2 files changed

+21
-15
lines changed

README.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,30 +19,36 @@ In addition, logs from the nozzle itself are of sourcetype `cf:splunknozzle`.
1919

2020
### Setup
2121

22-
The Nozzle requires a user with the scope `doppler.firehose` and
23-
`cloud_controller.admin_read_only` (the latter is only required if `ADD_APP_INFO` is true). If `cloud_controller.admin_read_only` is not
22+
The Nozzle requires a client with the authorities `doppler.firehose` and `cloud_controller.admin_read_only` (the latter is only required if `ADD_APP_INFO` is true) and grant-types `client_credentials` and `refresh_token`. If `cloud_controller.admin_read_only` is not
2423
available in the system, switch to use `cloud_controller.admin`.
2524

2625
You can either
27-
* Add the user manually using [uaac](https://github.com/cloudfoundry/cf-uaac)
28-
* Add a new user to the deployment manifest; see [uaa.scim.users](https://github.com/cloudfoundry/uaa-release/blob/master/jobs/uaa/spec)
26+
* Add the client manually using [uaac](https://github.com/cloudfoundry/cf-uaac)
27+
* Add the client to the deployment manifest; see [uaa.scim.users](https://github.com/cloudfoundry/uaa-release/blob/master/jobs/uaa/spec)
2928

3029
Manifest example:
3130

3231
```yaml
33-
uaa:
34-
scim:
35-
users:
36-
- splunk-firehose|password123|cloud_controller.admin_read_only,doppler.firehose
32+
33+
# Clients
34+
uaa.clients:
35+
splunk-firehose:
36+
id: splunk-firehose
37+
override: true
38+
secret: splunk-firehose-secret
39+
authorized-grant-types: client_credentials,refresh_token
40+
authorities: doppler.firehose,cloud_controller.admin_read_only
3741
```
3842
3943
`uaac` example:
4044
```shell
4145
uaac target https://uaa.[system domain url]
4246
uaac token client get admin -s [admin client credentials secret]
43-
uaac -t user add splunk-nozzle --password password123 --emails na
44-
uaac -t member add cloud_controller.admin_read_only splunk-nozzle
45-
uaac -t member add doppler.firehose splunk-nozzle
47+
uaac client add splunk-firehose --name splunk-firehose
48+
uaac client add splunk-firehose --secret [your_client_secret]
49+
uaac client add splunk-firehose --authorized_grant_types client_credentials,refresh_token
50+
uaac client add splunk-firehose --authorities doppler.firehose,cloud_controller.admin_read_only
51+
4652
```
4753

4854
`cloud_controller.admin_read_only` will work for cf v241
@@ -55,8 +61,8 @@ You can declare parameters by making a copy of the scripts/nozzle.sh.template.
5561

5662
__Cloud Foundry configuration parameters:__
5763
* `API_ENDPOINT`: Cloud Foundry API endpoint address.
58-
* `API_USER`: Cloud Foundry user name. (Must have scope described above)
59-
* `API_PASSWORD`: Cloud Foundry user password.
64+
* `CLIENT_ID`: UAA Client ID (Must have authorities and grant_types described above).
65+
* `CLIENT_SECRET`: Secret for Client ID.
6066

6167
__Splunk configuration parameters:__
6268
* `SPLUNK_TOKEN`: [Splunk HTTP event collector token](http://docs.splunk.com/Documentation/Splunk/latest/Data/UsetheHTTPEventCollector/).

ci/nozzle_manifest.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ applications:
88
env:
99
GOPACKAGENAME: main
1010
API_ENDPOINT:
11-
API_USER:
12-
API_PASSWORD:
11+
CLIENT_ID:
12+
CLIENT_SECRET:
1313
SPLUNK_HOST:
1414
SPLUNK_TOKEN:
1515
SPLUNK_INDEX:

0 commit comments

Comments
 (0)