Skip to content

Commit

Permalink
docs: (IAC-1267) Script Usage Credential Doc (#119)
Browse files Browse the repository at this point in the history
Closes #17
  • Loading branch information
jarpat authored Apr 10, 2024
1 parent 3cc6ba7 commit efab445
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/user/ScriptUsage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ After satisfying all of the requirements that are listed in the [README file](..

### vSphere/vCenter Environment File for Authentication

Create a file that contains the authentication variable values to use at container invocation. Store the file outside of this repository, for example in `$HOME/.vsphere_creds.env`. Protect that file with vSphere/vCenter credentials so that only you have Read access to it.
Create a file that contains the authentication variable values to use at script invocation. Store the file outside of this repository, for example in `$HOME/.vsphere_creds.env`. Protect that file with vSphere/vCenter credentials so that only you have Read access to it.

**NOTE**: Do not surround the values in the file with quotation marks, and make sure to avoid any trailing blank spaces.

Now each time you invoke the container, specify the file with the `--env-file` option to pass credentials to the container.
Now each time you invoke the script, export the variables within the file to pass the credentials to it. You can run `export $(grep -v '^#' ~/.vsphere_creds.env | xargs)` to export them all at once.

An example of this file can be found in the `examples` directory [here](./../../examples/vsphere/.vsphere_creds.env).

### Bare Metal Environment File for Authentication

Create a file that contains the authentication variable values to use at container invocation. Store the file outside of this repository, for example in `$HOME/.bare_metal_creds.env`. Protect that file with operating-system credentials so that only you have Read access to it
Create a file that contains the authentication variable values to use at script invocation. Store the file outside of this repository, for example in `$HOME/.bare_metal_creds.env`. Protect that file with operating-system credentials so that only you have Read access to it

**NOTE**: Do not surround the values in the file with quotation marks, and make sure to avoid any trailing blank spaces.

Now each time you invoke the container, specify the file with the --env-file option to pass credentials to the container.
Now each time you invoke the script, export the variables within the file to pass the credentials to it. You can run `export $(grep -v '^#' ~/.bare_metal_creds.env | xargs)` to export them all at once.

An example of this file can be found in the `examples` directory [here](./../../examples/bare-metal/.bare_metal_creds.env).

Expand Down

0 comments on commit efab445

Please sign in to comment.