This is an automated email from the ASF dual-hosted git repository.
daisyguo pushed a commit to branch master
in repository
https://gitbox.apache.org/repos/asf/incubator-openwhisk-deploy-kube.git
The following commit(s) were added to refs/heads/master by this push:
new 6700d1e variables in values.yaml should be in camelCase (#325)
6700d1e is described below
commit 6700d1ee08485297337682e3e8202b565b17c0b9
Author: David Grove <[email protected]>
AuthorDate: Fri Nov 2 05:10:47 2018 -0400
variables in values.yaml should be in camelCase (#325)
Per the Helm best practices document [1], variables in values.yaml
should be in camelCase
[1]
https://github.com/helm/helm/blob/master/docs/chart_best_practices/values.md
---
README.md | 16 ++++-----
docs/ingress.md | 38 +++++++++++-----------
helm/openwhisk-providers/charts/ow-alarm/README.md | 2 +-
.../charts/ow-cloudant/README.md | 2 +-
helm/openwhisk-providers/charts/ow-kafka/README.md | 2 +-
helm/openwhisk/templates/NOTES.txt | 2 +-
helm/openwhisk/templates/clusterConfigMaps.yaml | 14 ++++----
helm/openwhisk/templates/invoker.yaml | 4 +--
helm/openwhisk/templates/nginxConfigMap.yaml | 2 +-
helm/openwhisk/values.yaml | 12 +++----
tools/travis/build-helm.sh | 4 +--
11 files changed, 49 insertions(+), 49 deletions(-)
diff --git a/README.md b/README.md
index f6a8be5..0a3455b 100644
--- a/README.md
+++ b/README.md
@@ -194,16 +194,16 @@ file appropriate for a Minikube cluster where `minikube
ip` returns
`192.168.99.100` and port 31001 is available to be used. If you are
using Docker for Mac, you can use the same configuration but use the
command `kubectl describe nodes | grep InternalIP` to determine the
-value for `api_host_name`. If you are using kubeadm-dind-cluster, use
+value for `apiHostName`. If you are using kubeadm-dind-cluster, use
the command `kubectl describe node kube-node-2 | grep InternalIP` to
-determine the value for `api_host_name`.
+determine the value for `apiHostName`.
```yaml
whisk:
ingress:
type: NodePort
- api_host_name: 192.168.99.100
- api_host_port: 31001
+ apiHostName: 192.168.99.100
+ apiHostPort: 31001
nginx:
httpsNodePort: 31001
@@ -237,10 +237,10 @@ is ready to be used.
Configure the OpenWhisk CLI, wsk, by setting the auth and apihost
properties (if you don't already have the wsk cli, follow the
instructions [here](https://github.com/apache/incubator-openwhisk-cli)
-to get it). Replace `whisk.ingress.api_host_name` and
`whisk.ingress.api_host_port`
+to get it). Replace `whisk.ingress.apiHostName` and `whisk.ingress.apiHostPort`
with the actual values from your mycluster.yaml.
```shell
-wsk property set --apihost
whisk.ingress.api_host_name:whisk.ingress.api_host_port
+wsk property set --apihost whisk.ingress.apiHostName:whisk.ingress.apiHostPort
wsk property set --auth
23bc46b1-71f6-4ed5-8c54-816aa4f8c502:123zO3xZCLrMN6v2BKK1dXYFpXlPkccOFqm12CdAsMgRU4VrNZ9lyGVCGuMDGIwP
```
### Configuring the CLI for Kubernetes on Docker for Mac
@@ -248,11 +248,11 @@ wsk property set --auth
23bc46b1-71f6-4ed5-8c54-816aa4f8c502:123zO3xZCLrMN6v2BKK
The `docker0` network interface does not exist in the Docker for Mac
host environment. Instead, exposed NodePorts are forwarded from localhost
to the appropriate containers. This means that you will use `localhost`
-instead of `whisk.ingress.api_host_name` as your apihost when configuring
+instead of `whisk.ingress.apiHostName` as your apihost when configuring
the `wsk` cli.
```shell
-wsk property set --apihost localhost:whisk.ingress.api_host_port
+wsk property set --apihost localhost:whisk.ingress.apiHostPort
wsk property set --auth
23bc46b1-71f6-4ed5-8c54-816aa4f8c502:123zO3xZCLrMN6v2BKK1dXYFpXlPkccOFqm12CdAsMgRU4VrNZ9lyGVCGuMDGIwP
```
diff --git a/docs/ingress.md b/docs/ingress.md
index 3460b37..f95aea7 100644
--- a/docs/ingress.md
+++ b/docs/ingress.md
@@ -25,8 +25,8 @@ are going to deploy available outside of your Kubernetes
cluster. When
you select an ingress method, you are determining what values to use
for the `whisk.ingress` stanza of your `mycluster.yaml` file that you
will use in the `helm install` command. You will need to define
-values for at least `whisk.ingress.type` and `whisk.ingress.api_host_name`
-and `whisk.ingress.api_host_port`.
+values for at least `whisk.ingress.type` and `whisk.ingress.apiHostName`
+and `whisk.ingress.apiHostPort`.
Unfortunately, the exact details of configuring an Ingress can vary
across cloud providers. The detailed instructions describe multiple
@@ -61,8 +61,8 @@ Next pick an unassigned port (eg 31001) and define
`mycluster.yaml` as
whisk:
ingress:
type: NodePort
- api_host_name: 192.168.99.100
- api_host_port: 31001
+ apiHostName: 192.168.99.100
+ apiHostPort: 31001
nginx:
httpsNodePort: 31001
@@ -81,8 +81,8 @@ Next pick an unassigned port (eg 31001) and define
`mycluster.yaml` as
whisk:
ingress:
type: NodePort
- api_host_name: 192.168.65.3
- api_host_port: 31001
+ apiHostName: 192.168.65.3
+ apiHostPort: 31001
nginx:
httpsNodePort: 31001
@@ -106,8 +106,8 @@ Next pick an unassigned port (eg 31001) and define
`mycluster.yaml` as
whisk:
ingress:
type: NodePort
- api_host_name: 10.192.0.3
- api_host_port: 31001
+ apiHostName: 10.192.0.3
+ apiHostPort: 31001
nginx:
httpsNodePort: 31001
@@ -126,8 +126,8 @@ Then define `mycluster.yaml` as
whisk:
ingress:
type: NodePort
- api_host_name: YOUR_WORKERS_PUBLIC_IP_ADDR
- api_host_port: 31001
+ apiHostName: YOUR_WORKERS_PUBLIC_IP_ADDR
+ apiHostPort: 31001
nginx:
httpsNodePort: 31001
@@ -145,9 +145,9 @@ parameters from your `mycluster.yaml`. Generically, your
```yaml
whisk:
ingress:
- api_host_name: *<domain>*
- api_host_port: 443
- api_host_proto: https
+ apiHostName: *<domain>*
+ apiHostPort: 443
+ apiHostProto: https
type: standard
domain: *<domain>*
tls:
@@ -195,9 +195,9 @@ Now define `mycluster.yaml` as below (substituting the real
values for
```yaml
whisk:
ingress:
- api_host_name: <domain>
- api_host_port: 443
- api_host_proto: https
+ apiHostName: <domain>
+ apiHostPort: 443
+ apiHostProto: https
type: standard
domain: <domain>
tls:
@@ -249,9 +249,9 @@ Now define `mycluster.yaml` as below:
```yaml
whisk:
ingress:
- api_host_name: <domain>
- api_host_port: 443
- api_host_proto: https
+ apiHostName: <domain>
+ apiHostPort: 443
+ apiHostProto: https
type: standard
domain: <domain>
tls:
diff --git a/helm/openwhisk-providers/charts/ow-alarm/README.md
b/helm/openwhisk-providers/charts/ow-alarm/README.md
index 924dc5b..1c51098 100644
--- a/helm/openwhisk-providers/charts/ow-alarm/README.md
+++ b/helm/openwhisk-providers/charts/ow-alarm/README.md
@@ -58,7 +58,7 @@ or you can pass Kubernetes DNS to invoker. First you can get
the IP address of K
```
# Invoker configurations
invoker:
- kube_dns: "<IP_Address_Of_Kube_DNS>"
+ kubeDNS: "<IP_Address_Of_Kube_DNS>"
```
## Install
diff --git a/helm/openwhisk-providers/charts/ow-cloudant/README.md
b/helm/openwhisk-providers/charts/ow-cloudant/README.md
index 65c995c..aff57a6 100644
--- a/helm/openwhisk-providers/charts/ow-cloudant/README.md
+++ b/helm/openwhisk-providers/charts/ow-cloudant/README.md
@@ -60,7 +60,7 @@ If you want to use the `DockerContainerFactory` you can
instead attempt to confi
```
# Invoker configurations
invoker:
- kube_dns: "<IP_Address_Of_Kube_DNS>"
+ kubeDNS: "<IP_Address_Of_Kube_DNS>"
```
## Install
diff --git a/helm/openwhisk-providers/charts/ow-kafka/README.md
b/helm/openwhisk-providers/charts/ow-kafka/README.md
index 1fb1a5a..801a499 100644
--- a/helm/openwhisk-providers/charts/ow-kafka/README.md
+++ b/helm/openwhisk-providers/charts/ow-kafka/README.md
@@ -58,7 +58,7 @@ If you want to use the `DockerContainerFactory` you can
instead attempt to confi
```
# Invoker configurations
invoker:
- kube_dns: "<IP_Address_Of_Kube_DNS>"
+ kubeDNS: "<IP_Address_Of_Kube_DNS>"
```
## Install
diff --git a/helm/openwhisk/templates/NOTES.txt
b/helm/openwhisk/templates/NOTES.txt
index 724589c..20f85ee 100644
--- a/helm/openwhisk/templates/NOTES.txt
+++ b/helm/openwhisk/templates/NOTES.txt
@@ -14,7 +14,7 @@ and port 443 in the command below:
$ wsk property set --apihost NGINX_SERVICE_EXTERNAL_IP:443
{{- else }}
using the command below:
- $ wsk property set --apihost {{ .Values.whisk.ingress.api_host_name -}}:{{-
.Values.whisk.ingress.api_host_port }}
+ $ wsk property set --apihost {{ .Values.whisk.ingress.apiHostName -}}:{{-
.Values.whisk.ingress.apiHostPort }}
{{- end }}
Your release is named {{ .Release.Name }}.
diff --git a/helm/openwhisk/templates/clusterConfigMaps.yaml
b/helm/openwhisk/templates/clusterConfigMaps.yaml
index 49a5457..a581a64 100644
--- a/helm/openwhisk/templates/clusterConfigMaps.yaml
+++ b/helm/openwhisk/templates/clusterConfigMaps.yaml
@@ -6,8 +6,8 @@
#
{{- if ne .Values.whisk.ingress.type "LoadBalancer" }}
# whisk.ingress.type is {{ required "You must provide a value for
whisk.ingress.type (See docs/ingress.md)" .Values.whisk.ingress.type }}
-# whisk.ingress.api_host_name is {{ required "You must provide a value for
whisk.ingress.api_host_name (See docs/ingress.md)"
.Values.whisk.ingress.api_host_name }}
-# whisk.ingress.api_host_port is {{ required "You must provide a value for
whisk.ingress.api_host_port (See docs/ingress.md)"
.Values.whisk.ingress.api_host_port }}
+# whisk.ingress.apiHostName is {{ required "You must provide a value for
whisk.ingress.apiHostName (See docs/ingress.md)"
.Values.whisk.ingress.apiHostName }}
+# whisk.ingress.apiHostPort is {{ required "You must provide a value for
whisk.ingress.apiHostPort (See docs/ingress.md)"
.Values.whisk.ingress.apiHostPort }}
{{- end }}
---
@@ -28,11 +28,11 @@ data:
whisk_api_host_nameAndPort: "{{ .Values.nginx.name }}.{{ .Release.Namespace
}}.svc.{{ .Values.k8s.domain }}:{{ .Values.nginx.httpsPort }}"
whisk_api_host_url: "https://{{ .Values.nginx.name }}.{{ .Release.Namespace
}}.svc.{{ .Values.k8s.domain }}:{{ .Values.nginx.httpsPort }}"
{{- else }}
- whisk_api_host_proto: {{ .Values.whisk.ingress.api_host_proto | quote }}
- whisk_api_host_port: {{ .Values.whisk.ingress.api_host_port | quote }}
- whisk_api_host_name: {{ .Values.whisk.ingress.api_host_name | quote }}
- whisk_api_host_nameAndPort: "{{ .Values.whisk.ingress.api_host_name }}:{{
.Values.whisk.ingress.api_host_port }}"
- whisk_api_host_url: "{{ .Values.whisk.ingress.api_host_proto }}://{{
.Values.whisk.ingress.api_host_name }}:{{ .Values.whisk.ingress.api_host_port
}}"
+ whisk_api_host_proto: {{ .Values.whisk.ingress.apiHostProto | quote }}
+ whisk_api_host_port: {{ .Values.whisk.ingress.apiHostPort | quote }}
+ whisk_api_host_name: {{ .Values.whisk.ingress.apiHostName | quote }}
+ whisk_api_host_nameAndPort: "{{ .Values.whisk.ingress.apiHostName }}:{{
.Values.whisk.ingress.apiHostPort }}"
+ whisk_api_host_url: "{{ .Values.whisk.ingress.apiHostProto }}://{{
.Values.whisk.ingress.apiHostName }}:{{ .Values.whisk.ingress.apiHostPort }}"
{{- end }}
---
diff --git a/helm/openwhisk/templates/invoker.yaml
b/helm/openwhisk/templates/invoker.yaml
index 5e3641a..50580a2 100644
--- a/helm/openwhisk/templates/invoker.yaml
+++ b/helm/openwhisk/templates/invoker.yaml
@@ -96,9 +96,9 @@ spec:
value: {{ .Values.whisk.loadbalancer.invokerUserMemory | quote }}
# DNS Server passed to action containers
-{{- if not (eq .Values.invoker.kube_dns "nil") }}
+{{- if not (eq .Values.invoker.kubeDNS "nil") }}
- name: "CONFIG_whisk_containerFactory_containerArgs_dnsServers_0"
- value: {{ .Values.invoker.kube_dns }}
+ value: {{ .Values.invoker.kubeDNS }}
{{ end }}
# Invoker name is the name of the node (DaemonSet) or pod
(StatefulSet)
diff --git a/helm/openwhisk/templates/nginxConfigMap.yaml
b/helm/openwhisk/templates/nginxConfigMap.yaml
index f067fb8..9552538 100644
--- a/helm/openwhisk/templates/nginxConfigMap.yaml
+++ b/helm/openwhisk/templates/nginxConfigMap.yaml
@@ -37,7 +37,7 @@ data:
# match namespace, note while OpenWhisk allows a richer character set
for a
# namespace, not all those characters are permitted in the (sub)domain
name;
# if namespace does not match, no vanity URL rewriting takes place.
- server_name ~^(?<namespace>[0-9a-zA-Z-]+)\.{{
.Values.whisk.ingress.api_host_name }}$;
+ server_name ~^(?<namespace>[0-9a-zA-Z-]+)\.{{
.Values.whisk.ingress.apiHostName }}$;
ssl_session_cache shared:SSL:1m;
ssl_session_timeout 10m;
diff --git a/helm/openwhisk/values.yaml b/helm/openwhisk/values.yaml
index 43e17c0..51992f5 100644
--- a/helm/openwhisk/values.yaml
+++ b/helm/openwhisk/values.yaml
@@ -6,8 +6,8 @@
# used in the OpenWhisk Helm Chart. The variables are grouped
# by component into subtrees.
#
-# You _MUST_ override the default values of whisk.ingress.api_host_name
-# and whisk.ingress.api_host_port (see docs/ingress.md for a discussion
+# You _MUST_ override the default values of whisk.ingress.apiHostName
+# and whisk.ingress.apiHostPort (see docs/ingress.md for a discussion
# of how to determine values for these variables).
#
# Production deployments _MUST_ override the default credentials
@@ -24,9 +24,9 @@ whisk:
# See docs/ingress.md for a discussion of how to provide these values.
ingress:
name: "ow-ingress"
- api_host_name: nil
- api_host_port: nil
- api_host_proto: "https"
+ apiHostName: nil
+ apiHostPort: nil
+ apiHostProto: "https"
# Production deployments _MUST_ override these default auth values
auth:
system:
"789c46b1-71f6-4ed5-8c54-816aa4f8c502:abczO3xZCLrMN6v2BKK1dXYFpXlPkccOFqm12CdAsMgRU4VrNZ9lyGVCGuMDGIwP"
@@ -184,7 +184,7 @@ invoker:
enabled: false
port: 3233
containerNetwork: "bridge"
- kube_dns: nil
+ kubeDNS: nil
# API Gateway configurations
apigw:
diff --git a/tools/travis/build-helm.sh b/tools/travis/build-helm.sh
index 2dcd8b0..14c89c6 100755
--- a/tools/travis/build-helm.sh
+++ b/tools/travis/build-helm.sh
@@ -209,8 +209,8 @@ cat > mycluster.yaml <<EOF
whisk:
ingress:
type: NodePort
- api_host_name: $WSK_HOST
- api_host_port: $WSK_PORT
+ apiHostName: $WSK_HOST
+ apiHostPort: $WSK_PORT
runtimes: "runtimes-minimal-travis.json"
invoker:
