Helm-Toolkit: Add doc comments for keystone env snippets

This PS adds doc comments for the keystone env snippets

Change-Id: Ia18b3101e639a713b7cc1c88146a2f91bbcb3984
Signed-off-by: Pete Birley <pete@port.direct>
This commit is contained in:
Pete Birley 2018-09-13 06:56:28 -05:00 committed by Pete Birley
parent 274b230dcc
commit 26fd6bc04c
2 changed files with 98 additions and 0 deletions

View File

@ -14,6 +14,61 @@ See the License for the specific language governing permissions and
limitations under the License.
*/}}
{{/*
abstract: |
Returns a set of container enviorment variables, equivlant to an openrc for
use with keystone based command line clients.
values: |
secrets:
identity:
admin: example-keystone-admin
usage: |
{{ include "helm-toolkit.snippets.keystone_openrc_env_vars" ( dict "ksUserSecret" .Values.secrets.identity.admin ) }}
return: |
- name: OS_IDENTITY_API_VERSION
value: "3"
- name: OS_AUTH_URL
valueFrom:
secretKeyRef:
name: example-keystone-admin
key: OS_AUTH_URL
- name: OS_REGION_NAME
valueFrom:
secretKeyRef:
name: example-keystone-admin
key: OS_REGION_NAME
- name: OS_INTERFACE
valueFrom:
secretKeyRef:
name: example-keystone-admin
key: OS_INTERFACE
- name: OS_PROJECT_DOMAIN_NAME
valueFrom:
secretKeyRef:
name: example-keystone-admin
key: OS_PROJECT_DOMAIN_NAME
- name: OS_PROJECT_NAME
valueFrom:
secretKeyRef:
name: example-keystone-admin
key: OS_PROJECT_NAME
- name: OS_USER_DOMAIN_NAME
valueFrom:
secretKeyRef:
name: example-keystone-admin
key: OS_USER_DOMAIN_NAME
- name: OS_USERNAME
valueFrom:
secretKeyRef:
name: example-keystone-admin
key: OS_USERNAME
- name: OS_PASSWORD
valueFrom:
secretKeyRef:
name: example-keystone-admin
key: OS_PASSWORD
*/}}
{{- define "helm-toolkit.snippets.keystone_openrc_env_vars" }}
{{- $ksUserSecret := .ksUserSecret }}
- name: OS_IDENTITY_API_VERSION

View File

@ -14,6 +14,49 @@ See the License for the specific language governing permissions and
limitations under the License.
*/}}
{{/*
abstract: |
Returns a set of container enviorment variables, for use with the keystone
user management jobs.
values: |
secrets:
identity:
service_user: example-keystone-user
usage: |
{{ include "helm-toolkit.snippets.keystone_user_create_env_vars" ( dict "ksUserSecret" .Values.secrets.identity.service_user ) }}
return: |
- name: SERVICE_OS_REGION_NAME
valueFrom:
secretKeyRef:
name: example-keystone-user
key: OS_REGION_NAME
- name: SERVICE_OS_PROJECT_DOMAIN_NAME
valueFrom:
secretKeyRef:
name: example-keystone-user
key: OS_PROJECT_DOMAIN_NAME
- name: SERVICE_OS_PROJECT_NAME
valueFrom:
secretKeyRef:
name: example-keystone-user
key: OS_PROJECT_NAME
- name: SERVICE_OS_USER_DOMAIN_NAME
valueFrom:
secretKeyRef:
name: example-keystone-user
key: OS_USER_DOMAIN_NAME
- name: SERVICE_OS_USERNAME
valueFrom:
secretKeyRef:
name: example-keystone-user
key: OS_USERNAME
- name: SERVICE_OS_PASSWORD
valueFrom:
secretKeyRef:
name: example-keystone-user
key: OS_PASSWORD
*/}}
{{- define "helm-toolkit.snippets.keystone_user_create_env_vars" }}
{{- $ksUserSecret := .ksUserSecret }}
- name: SERVICE_OS_REGION_NAME