Removing long parameter names from rest sample

Author: AdrianPadilla

integration-tests/src/test/java/oracle/kubernetes/operator/utils/Operator.java

@@ -280,6 +280,7 @@ private void generateInputYaml(boolean useLegacyRESTIdentity) throws Exception {
     sb.append(TestUtils.getHostName());
     sb.append(" >> ");
     sb.append(generatedInputYamlFile);
+    logger.info("Invoking " + sb.toString());
     ExecCommand.exec(sb.toString());
   }
 

kubernetes/samples/scripts/rest/README.md

@@ -20,7 +20,7 @@ the namespace where the operator will be installed, and optionally the secret na
 to `weblogic-operator-external-rest-identity`.  Each must be prefaced
 by `DNS:` (for a name) or `IP:` (for an address), for example:
 ```
-DNS:myhost,DNS:localhost,IP:127.0.0.1 -n weblogic-operator
+DNS:myhost,DNS:localhost,IP:127.0.0.1
 ```
 
 You should include the addresses of all masters and load balancers in this list.  The certificate

kubernetes/samples/scripts/rest/generate-external-rest-identity.sh

@@ -13,12 +13,12 @@
 #
 # The sytax of the script is:
 #
-#   kubernetes/samples/scripts/rest/generate-external-rest-identity.sh <SANs> -n <namespace>
+#   kubernetes/samples/scripts/rest/generate-external-rest-identity.sh -a <SANs> -n <namespace>
 #
 # Where <SANs> lists the subject alternative names to put into the generated self-signed 
 # certificate for the external WebLogic Operator REST https interface, for example:
 #
-#   DNS:myhost,DNS:localhost,IP:127.0.0.1 -n weblogic-operator
+#   DNS:myhost,DNS:localhost,IP:127.0.0.1
 #
 # You should include the addresses of all masters and load balancers in this list.  The certificate
 # cannot be conveniently changed after installation of the operator.
@@ -27,19 +27,18 @@
 # certificate and private key
 #
 # Example usage:
-#   generate-external-rest-identity.sh IP:127.0.0.1 -n weblogic-operator > my_values.yaml
+#   generate-external-rest-identity.sh -a IP:127.0.0.1 -n weblogic-operator > my_values.yaml
 #   echo "externalRestEnabled: true" >> my_values.yaml
 #   ...
 #   helm install kubernetes/charts/weblogic-operator --name my_operator --namespace my_operator-ns --values my_values.yaml --wait
 usage(){
 cat <<EOF
-Usage: $0 [options] <subject alternative names> <-n namespace>
+Usage: $0 [options] -a <subject alternative names> -n <namespace>
 Options:
-    --subject-alternative-name SANS Required, the SANs for the certificate
--n, --namespace NAMESPACE           Required, the namespace where the secret will be created.
--s, --secret-name SECRET_NAME       Optional, the name of the kubernetes secret. Default is: 
-                                    weblogic-operator-external-rest-identity.
--h, --help                          Display this help text.
+-a  SANS           Required, the SANs for the certificate
+-n  NAMESPACE      Required, the namespace where the secret will be created.
+-s  SECRET_NAME    Optional, the name of the kubernetes secret. Default is: weblogic-operator-external-rest-identity.
+-h, --help         Display this help text.
 EOF
 exit 1
 }
@@ -88,25 +87,25 @@ while [ $# -gt 0 ]
   do 
     key="$1"
     case $key in
-      --subject-alternative-name)
+      -a)
       shift # past argument
       if [ $# -eq 0 ] || [ ${1:0:1} == "-" ]; then echo "SANs is required and is missing"; usage; fi
       SANS=$1
       shift # past value
       ;;
-      -n|--namespace)
+      -n)
       shift # past argument
       if [ $# -eq 0 ] || [ ${1:0:1} == "-" ]; then echo "Namespace is required and is missing"; usage; fi
       NAMESPACE=$1
       shift # past value
       ;;
-      -s|--secret-name)
+      -s)
       shift # past argument
       if [ $# -eq 0 ] || [ ${1:0:1} == "-" ]; then echo "Invalid secret name $1"; usage; fi
       SECRET_NAME=$1
       shift # past value
       ;;
-      -h|--help)
+      -h)
       shift # past argument
       ;;
       *)

site/install.md

@@ -80,7 +80,7 @@ ___This script should not be used in a production environment (because self-sign
 
 The script takes the subject alternative names that should be added to the certificate, for example, the list of hostnames that clients can use to access the external REST interface, the optional secret name to store the certificate (defaults to weblogic-operator-external-rest-identity) and the namespace where the operator will be installed. In this example, the output is directly appended to your custom YAML configuration:
 ```
-$ kubernetes/samples/scripts/rest/generate-external-rest-identity.sh "DNS:${HOSTNAME},DNS:localhost,IP:127.0.0.1 -n weblogic-operator " >> custom-values.yaml
+$ kubernetes/samples/scripts/rest/generate-external-rest-identity.sh -a "DNS:${HOSTNAME},DNS:localhost,IP:127.0.0.1" -n weblogic-operator >> custom-values.yaml
 ```
 
 ## Optional: Elastic Stack (Elasticsearch, Logstash, and Kibana) integration
@@ -328,7 +328,7 @@ Determines whether the operator's REST interface will be exposed outside the Kub
 
 Defaults to `false`.
 
-If set to `true`, you must provide the SSL certificate and private key for the operator's external REST interface by specifying the `externalOperatorCert` and `externalOperatorKey` properties.
+If set to `true`, you must provide the `externalRestIdentitySecret` property that contains the name of the Kubernetes secret which contains the SSL certificate and private key for the operator's external REST interface.
 
 Example:
 ```