[incubator-openwhisk-deploy-kube] branch master updated: add explicit checks to ensure required variables are defined (#242)

[da...@apache.org]

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 8a9460d  add explicit checks to ensure required variables are defined (#242)
8a9460d is described below

commit 8a9460da80a62a0f6f9c947cf93e1dad4d3370ba
Author: David Grove <dg...@users.noreply.github.com>
AuthorDate: Tue Jul 3 23:16:23 2018 -0400

    add explicit checks to ensure required variables are defined (#242)
    
    Add explicit checks using the required operator for variables that
    the user must define (ie, that have no sensible default). This enables
    better error messages to be generated that can direct the user to the
    relevant documentation on how to define the variable.
    
    Fixes #240.
---
 helm/templates/clusterConfigMaps.yaml | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/helm/templates/clusterConfigMaps.yaml b/helm/templates/clusterConfigMaps.yaml
index d9030dc..4167ce9 100644
--- a/helm/templates/clusterConfigMaps.yaml
+++ b/helm/templates/clusterConfigMaps.yaml
@@ -1,6 +1,14 @@
 # Licensed to the Apache Software Foundation (ASF) under one or more contributor
 # license agreements; and to You under the Apache License, Version 2.0.
 
+# There are some variables that a user must define for their deployment.
+# Check for those values here and attempt to give helpful error messages.
+#
+# 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 }}
+
+---
 apiVersion: v1
 kind: ConfigMap
 metadata: