added documentation around environment variables

This commit is contained in:
Gabe Muniz
2021-04-15 17:33:31 -04:00
parent 51b2a211cb
commit f68dc77ea3
3 changed files with 27 additions and 0 deletions

View File

@@ -27,6 +27,7 @@ An [Ansible AWX](https://github.com/ansible/awx) operator for Kubernetes built w
* [LDAP Certificate Authority](#ldap-certificate-authority)
* [Persisting Projects Directory](#persisting-projects-directory)
* [Custom Volume and Volume Mount Options](#custom-volume-and-volume-mount-options)
* [Exporting Environment Variables to Containers](#exporting-environment-variables-to-containers)
* [Development](#development)
* [Testing](#testing)
* [Testing in Docker](#testing-in-docker)
@@ -477,6 +478,28 @@ Example spec file for volumes and volume mounts
> :warning: **Volume and VolumeMount names cannot contain underscores(_)**
#### Exporting Environment Variables to Containers
If you need to export custom environment variables to your containers.
| Name | Description | Default |
| ----------------------------- | -------------------------------------------------------- | ------- |
| tower_task_extra_env | Environment variables to be added to Task container | '' |
| tower_web_extra_env | Environment variables to be added to Web container | '' |
Example configuration of environment variables
```yaml
spec:
tower_task_extra_env: |
- name: MYCUSTOMVAR
value: foo
tower_web_extra_env: |
- name: MYCUSTOMVAR
value: foo
```
## Development
### Testing

View File

@@ -295,6 +295,7 @@ spec:
- urn:alm:descriptor:com.tectonic.ui:advanced
- urn:alm:descriptor:com.tectonic.ui:hidden
- displayName: Tower Task Extra Env
description: Environment variables to be added to Task container
path: tower_task_extra_env
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:advanced
@@ -322,6 +323,7 @@ spec:
- urn:alm:descriptor:com.tectonic.ui:advanced
- urn:alm:descriptor:com.tectonic.ui:hidden
- displayName: Tower Web Extra Env
description: Environment variables to be added to Web container
path: tower_web_extra_env
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:advanced

View File

@@ -225,6 +225,7 @@ spec:
type: string
type: array
tower_task_extra_env:
description: Environment variables to be added to Task container
type: string
tower_ee_extra_volume_mounts:
description: Specify volume mounts to be added to Execution container
@@ -270,6 +271,7 @@ spec:
type: string
type: array
tower_web_extra_env:
description: Environment variables to be added to Web container
type: string
tower_web_extra_volume_mounts:
description: Specify volume mounts to be added to web container