Skip to content

Commit cf7a330

Browse files
author
Alan Christie
committed
docs: Doc tweak
1 parent c2ea8a0 commit cf7a330

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ the required endpoint: -
2727
/event-stream GET
2828
/event-stream/{id} DELETE
2929

30-
See the AS Event Stream API documentation for more details, and the discussion
31-
of the [Event Streams] service on its internal wiki.
30+
See the AS documentation for more details, and the discussion of the [Event Streams]
31+
service on its internal wiki.
3232

3333
## Contributing
3434
The project uses: -
@@ -61,6 +61,8 @@ need to customise the playbook by first defining your own variables.
6161

6262
To install the application follow the steps below.
6363

64+
> You will need access to your Kubernetes cluster and a **KUBECONFIG** file.
65+
6466
From a poetry shell, install the required dependencies: -
6567

6668
poetry install --with deploy
@@ -80,8 +82,10 @@ accidental commits as it's in the project's `.gitignore` file: -
8082

8183
cp parameters-template.yaml parameters.yaml
8284

83-
Then, when you have set your variables, run the playbook: -
85+
Then, when you have set your variables, identify your **KUBECONFIG** file,
86+
and run the playbook: -
8487

88+
export KUBECONFIG=<path-to-your-kubeconfig>
8589
ansible-playbook site.yaml -e @parameters.yaml
8690

8791
To remove the application run the playbook again, but set the `ess_state` variable

0 commit comments

Comments
 (0)