rabbah closed pull request #149: misc. small doc fixes URL: https://github.com/apache/incubator-openwhisk-deploy-kube/pull/149
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/README.md b/README.md index 5525911..cc701e5 100644 --- a/README.md +++ b/README.md @@ -47,14 +47,14 @@ use to deploy OpenWhisk on Kubernetes for our Travis CI testing. ## Initial Cluster Configuration -* Follow the steps for initial [Cluster Setup](kubernetes/cluster-setup/README.md) -* Configure your [Ingresses](kubernetes/ingress/README.md), including configuring the wsk CLI. +* Follow the steps for initial [Cluster Setup](kubernetes/cluster-setup) +* Configure your [Ingresses](kubernetes/ingress), including configuring the wsk CLI. ## Configure or Deploy CouchDB Do one of the following: * For development and testing purposes, this repo includes a configuration - for deploying a [simple non-persistent CouchDB instance](kubernetes/couchdb/README.md) + for deploying a [simple non-persistent CouchDB instance](kubernetes/couchdb) within the Kubernetes cluster. * For a production level CouchDB instance, take a look at the main OpenWhisk [documentation for configuring CouchDB](https://github.com/apache/incubator-openwhisk/blob/master/tools/db/README.md). @@ -68,17 +68,17 @@ an order that respects their dependencies. Detailed instructions and the supporting configuration files can be found in the kubernetes directory tree. Follow the instructions for each step in order. -* Deploy [ApiGateway](kubernetes/apigateway/README.md) -* Deploy [Zookeeper](kubernetes/zookeeper/README.md) -* Deploy [Kafka](kubernetes/kafka/README.md) -* Deploy [Controller](kubernetes/controller/README.md) -* Deploy [Invoker](kubernetes/invoker/README.md) -* Deploy [Nginx](kubernetes/nginx/README.md) +* Deploy [ApiGateway](kubernetes/apigateway) +* Deploy [Zookeeper](kubernetes/zookeeper) +* Deploy [Kafka](kubernetes/kafka) +* Deploy [Controller](kubernetes/controller) +* Deploy [Invoker](kubernetes/invoker) +* Deploy [Nginx](kubernetes/nginx) ## Install system actions and the openwhisk catalog -* Install [RouteMgmt](kubernetes/routemgmt/README.md) -* Install [Package Catalog](kubernetes/openwhisk-catalog/README.md) +* Install [RouteMgmt](kubernetes/routemgmt) +* Install [Package Catalog](kubernetes/openwhisk-catalog) ## Verify @@ -86,6 +86,8 @@ Your OpenWhisk installation should now be usable. You can test it by following [these instructions](https://github.com/apache/incubator-openwhisk/blob/master/docs/actions.md) to define and invoke a sample OpenWhisk action in your favorite programming language. +Note: if you installed self-signed certificates when you configured Nginx, you will need to use `wsk -i` to suppress certificate checking. This works around `cannot validate certificate` errors from the `wsk` CLI. + # Cleanup At some point there might be a need to cleanup the Kubernetes environment. diff --git a/kubernetes/cluster-setup/README.md b/kubernetes/cluster-setup/README.md index 45d27e9..740695d 100644 --- a/kubernetes/cluster-setup/README.md +++ b/kubernetes/cluster-setup/README.md @@ -22,7 +22,7 @@ kubectl apply -f services.yml ### Configure system-wide version information and settings -Edit whisk.env as needed to set the appropriate values for your +Edit config.env as needed to set the appropriate values for your deployment, then create the configmap whisk.config: ``` diff --git a/kubernetes/ingress/README.md b/kubernetes/ingress/README.md index 8cc8cc6..3b985c4 100644 --- a/kubernetes/ingress/README.md +++ b/kubernetes/ingress/README.md @@ -10,8 +10,9 @@ instructions in the appropriate subsection of Possible Ingress Types. # Configuration Steps 1. Create an Ingress, thus determining a value you should use for -API_HOST. Unfortunately, the exact details of configuring an Ingress -vary across cloud providers. The detailed instructions +API_HOST. If you are deploying on minikube, follow the instructions for +the NodePort ingress. Unfortunately, the exact details of configuring +an Ingress vary across cloud providers. The detailed instructions [below](#possible-ingress-types) describe multiple possible Ingress configurations. We welcome contributions from the community to describe how to configure Ingress for additional cloud providers. @@ -47,7 +48,11 @@ numbers, you can determine your API_HOST and APIGW_URL. There are no additional files to apply. TLS termination is handled by the nginx service. - 1. Obtain the IP address of the Kubernetes nodes. + 1. Obtain the IP address of the Kubernetes nodes. If you are using minikube, use the command +``` + minikube ip + ``` + otherwise use ``` kubectl get nodes ``` ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
