Skip to content

Commit

Permalink
docs: Doc tweak
Browse files Browse the repository at this point in the history
  • Loading branch information
Alan Christie committed Sep 24, 2024
1 parent 4051961 commit 1bb632e
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,13 +155,25 @@ the storage class to `nfs`: -
-e fp_play=db-server-configure_create-database \
-e fp_work_volume_storageclass=nfs

After displaying the contents of the parameter file, the `KUBECONFIG` file and the
player container image details each play will ask you to confirm that you want to run
the play before anything destructive happens.

As individual plays can take a considerable time to run the `site-player`
playbook does not wait for the result - you need to
inspect the _player_ Pod yourself to check on the its progress.

> The player playbooks here will prevent you from running another _play_ while
one is running.

## Exposed parameter file content
Please be aware that when you rub a playbook the parameter file you provide to control
the play (fragment, extract, etc.) will be exposed in the Ansible output log here and
injected into the _player_ container using a Kubernetes `ConfigMap`.
Consequently, any 'sensitive' information that you put in a parameter file
will be visible in the local log and to anyone who has access the the Kubernetes
**fragmentor** `Namespace` used to run the plays.

## Cheat-sheet
With a `parameter.yaml` file like the following in your project directory
(which expects to find xchem/dsip data in your bucket) you should be able to
Expand Down

0 comments on commit 1bb632e

Please sign in to comment.