87b3b5b907
This PS adds basic documentation for the metadata labels function. Change-Id: I8ef3093aafabb64c61396a721b6c6b66dc5de9e8 Signed-off-by: Pete Birley <pete@port.direct>
38 lines
1.1 KiB
Smarty
38 lines
1.1 KiB
Smarty
{{/*
|
|
Copyright 2017 The Openstack-Helm Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/}}
|
|
|
|
{{/*
|
|
abstract: |
|
|
Renders a set of standardised labels
|
|
values: |
|
|
release_group: null
|
|
usage: |
|
|
{{ tuple . "foo" "bar" | include "helm-toolkit.snippets.kubernetes_metadata_labels" }}
|
|
return: |
|
|
release_group: RELEASE-NAME
|
|
application: foo
|
|
component: bar
|
|
*/}}
|
|
|
|
{{- define "helm-toolkit.snippets.kubernetes_metadata_labels" -}}
|
|
{{- $envAll := index . 0 -}}
|
|
{{- $application := index . 1 -}}
|
|
{{- $component := index . 2 -}}
|
|
release_group: {{ $envAll.Values.release_group | default $envAll.Release.Name }}
|
|
application: {{ $application }}
|
|
component: {{ $component }}
|
|
{{- end -}}
|