Skip to content

Commit

Permalink
hopefully final cleanups to prep for 1.0.0 release (#654)
Browse files Browse the repository at this point in the history
  • Loading branch information
dgrove-oss committed Nov 20, 2020
1 parent 0e2d41b commit 67e93b1
Show file tree
Hide file tree
Showing 5 changed files with 52 additions and 16 deletions.
23 changes: 23 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<!--
#
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You 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.
#
-->

# Changelog

## 1.0.0
* First Apache Release
2 changes: 1 addition & 1 deletion NOTICE.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Apache OpenWhisk
Apache OpenWhisk Deploy Kubernetes
Copyright 2016-2020 The Apache Software Foundation

This product includes software developed at
Expand Down
2 changes: 1 addition & 1 deletion helm/openwhisk/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
apiVersion: v2
type: application
name: openwhisk
version: 0.2.7
version: 1.0.0
home: https://openwhisk.apache.org
description: Apache OpenWhisk is an open source serverless cloud platform
icon: https://raw.githubusercontent.com/apache/openwhisk/682eb5b62ee6ba8017ab54226c2ace3637f4f1ec/docs/images/whisk_icon_full-color_with_tm_64x64-300dpi.png
Expand Down
15 changes: 7 additions & 8 deletions helm/openwhisk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Apache OpenWhisk is an open source, distributed serverless platform that execute

The [Apache OpenWhisk](https://openwhisk.apache.org/) serverless platform supports a programming model in which developers write functional logic (called Actions), in any supported programming language, that can be dynamically scheduled and run in response to associated events (via Triggers) from external sources (Feeds) or from HTTP requests.

This chart will deploy the core OpenWhisk platform to your Kubernetes cluster. In its default configuration, the chart enables runtime support for executing actions written in NodeJS, Python, Swift, Java, PHP, Ruby, Go, and "blackbox" docker containers. The main components of the OpenWhisk platform are a front-end that provides a REST API to the user and the `wsk` CLI, a CouchDB instance that stores user and system data, and a control plane that is responsible for scheduling incoming invocations of user actions onto dedicated Kubernetes worker nodes that have been labeled as "invoker nodes".
This chart will deploy the core OpenWhisk platform to your Kubernetes cluster. In its default configuration, the chart enables runtime support for executing actions written in NodeJS, Python, Swift, Java, PHP, Ruby, Go, Rust, .Net, and "blackbox" docker containers. The main components of the OpenWhisk platform are a front-end that provides a REST API to the user and the `wsk` CLI, a CouchDB instance that stores user and system data, and a control plane that is responsible for scheduling incoming invocations of user actions onto dedicated Kubernetes worker nodes that have been labeled as "invoker nodes".

Further documentation of the OpenWhisk system architecture, programming model, tutorials, and sample programs can all be found at on the [Apache OpenWhisk project website](https://openwhisk.apache.org/).

Expand All @@ -37,9 +37,8 @@ In its default configuration, this chart will create the following Kubernetes re
* Internal Services
* apigateway, controller, couchdb, kafka, nginx, redis, zookeeper
* OpenWhisk control plane Pods:
* DaemonSet: invoker (on all nodes with label `openwhisk-role=invoker`)
* Deployments: apigateway, couchdb, nginx, redis
* SatefulSets: controller, kafka, zookeeper
* SatefulSets: controller, invoker, kafka, zookeeper
* Persistent Volume Claims
* couchdb-pvc
* kafka-pvc
Expand All @@ -49,7 +48,7 @@ In its default configuration, this chart will create the following Kubernetes re

All user interaction with OpenWhisk uses the REST API exposed by the nginx service via its NodePort ingress.

The chart requires one or more Kubernetes worker nodes to be designated to be used by OpenWhisk's invokers to execute user actions. These nodes are designated by being labeled with `openwhisk-role=invoker` (see below for the `kubectl` command). In its default configuration, the invokers will schedule the containers to execute the user actions on these nodes *without* interacting with the Kubernetes scheduler.
The chart requires one or more Kubernetes worker nodes to be designated to be used by OpenWhisk's invokers to execute user actions. These nodes are designated by being labeled with `openwhisk-role=invoker` (see below for the `kubectl` command).

## Resources Required

Expand Down Expand Up @@ -145,12 +144,12 @@ Please ensure that you have reviewed the [prerequisites](#prerequisites) and the
To install the chart using helm cli:

```bash
$ helm install [--tls] openwhisk --namespace <my-namespace> --name <my-release> --set whisk.ingress.apiHostName=<cluster-ip-address>
$ helm install <my-release> openwhisk --namespace <my-namespace> --create-namespace --set whisk.ingress.apiHostName=<cluster-ip-address>
```

The command deploys OpenWhisk on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.

You can use the command ```helm status <my-release> [--tls]``` to get a summary of the various Kubernetes artifacts that make up your OpenWhisk deployment. Once the ```<my-release>-install-packages``` Pod is in the Completed state, your OpenWhisk deployment is ready to be used.
You can use the command ```helm status <my-release>``` to get a summary of the various Kubernetes artifacts that make up your OpenWhisk deployment. Once the ```<my-release>-install-packages``` Pod is in the Completed state, your OpenWhisk deployment is ready to be used.

### Configuration

Expand All @@ -160,15 +159,15 @@ You can use the command ```helm status <my-release> [--tls]``` to get a summary

To verify your deployment was successful, simply run:
```bash
helm test <my-release> [--tls] --cleanup
helm test <my-release> --cleanup
```

## Uninstalling the Chart

To uninstall/delete the deployment:

```bash
$ helm delete <my-release> --purge [--tls]
$ helm delete <my-release>
```

The command removes all the Kubernetes components associated with the chart and deletes the release.
Expand Down
26 changes: 20 additions & 6 deletions helm/openwhisk/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
{{/* Licensed to the Apache Software Foundation (ASF) under one or more contributor */}}
{{/* license agreements; and to You under the Apache License, Version 2.0. */}}
{{/*
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You 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.
*/}}
Apache OpenWhisk
Copyright 2016-2018 The Apache Software Foundation
Copyright 2016-2020 The Apache Software Foundation

This product includes software developed at
The Apache Software Foundation (http://www.apache.org/).
Expand All @@ -23,11 +37,11 @@ Your release is named {{ .Release.Name }}.

To learn more about the release, try:

$ helm status {{ .Release.Name }} [--tls]
$ helm get {{ .Release.Name }} [--tls]
$ helm status {{ .Release.Name }}
$ helm get {{ .Release.Name }}

Once the '{{ .Release.Name }}-install-packages' Pod is in the Completed state, your OpenWhisk deployment is ready to be used.

Once the deployment is ready, you can verify it using:

$ helm test {{ .Release.Name }} [--tls] --cleanup
$ helm test {{ .Release.Name }} --cleanup

0 comments on commit 67e93b1

Please sign in to comment.