Skip to content

Commit 67e93b1

Browse files
committed
hopefully final cleanups to prep for 1.0.0 release (#654)
1 parent 0e2d41b commit 67e93b1

File tree

5 files changed

+52
-16
lines changed

5 files changed

+52
-16
lines changed

CHANGELOG.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<!--
2+
#
3+
# Licensed to the Apache Software Foundation (ASF) under one or more
4+
# contributor license agreements. See the NOTICE file distributed with
5+
# this work for additional information regarding copyright ownership.
6+
# The ASF licenses this file to You under the Apache License, Version 2.0
7+
# (the "License"); you may not use this file except in compliance with
8+
# the License. You may obtain a copy of the License at
9+
#
10+
# http://www.apache.org/licenses/LICENSE-2.0
11+
#
12+
# Unless required by applicable law or agreed to in writing, software
13+
# distributed under the License is distributed on an "AS IS" BASIS,
14+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
# See the License for the specific language governing permissions and
16+
# limitations under the License.
17+
#
18+
-->
19+
20+
# Changelog
21+
22+
## 1.0.0
23+
* First Apache Release

NOTICE.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Apache OpenWhisk
1+
Apache OpenWhisk Deploy Kubernetes
22
Copyright 2016-2020 The Apache Software Foundation
33

44
This product includes software developed at

helm/openwhisk/Chart.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
apiVersion: v2
1919
type: application
2020
name: openwhisk
21-
version: 0.2.7
21+
version: 1.0.0
2222
home: https://openwhisk.apache.org
2323
description: Apache OpenWhisk is an open source serverless cloud platform
2424
icon: https://raw.githubusercontent.com/apache/openwhisk/682eb5b62ee6ba8017ab54226c2ace3637f4f1ec/docs/images/whisk_icon_full-color_with_tm_64x64-300dpi.png

helm/openwhisk/README.md

+7-8
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Apache OpenWhisk is an open source, distributed serverless platform that execute
2525

2626
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.
2727

28-
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".
28+
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".
2929

3030
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/).
3131

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

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

52-
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.
51+
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).
5352

5453
## Resources Required
5554

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

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

151150
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.
152151

153-
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.
152+
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.
154153

155154
### Configuration
156155

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

161160
To verify your deployment was successful, simply run:
162161
```bash
163-
helm test <my-release> [--tls] --cleanup
162+
helm test <my-release> --cleanup
164163
```
165164

166165
## Uninstalling the Chart
167166

168167
To uninstall/delete the deployment:
169168

170169
```bash
171-
$ helm delete <my-release> --purge [--tls]
170+
$ helm delete <my-release>
172171
```
173172

174173
The command removes all the Kubernetes components associated with the chart and deletes the release.

helm/openwhisk/templates/NOTES.txt

+20-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,21 @@
1-
{{/* Licensed to the Apache Software Foundation (ASF) under one or more contributor */}}
2-
{{/* license agreements; and to You under the Apache License, Version 2.0. */}}
1+
{{/*
2+
Licensed to the Apache Software Foundation (ASF) under one or more
3+
contributor license agreements. See the NOTICE file distributed with
4+
this work for additional information regarding copyright ownership.
5+
The ASF licenses this file to You under the Apache License, Version 2.0
6+
(the "License"); you may not use this file except in compliance with
7+
the License. You may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
See the License for the specific language governing permissions and
15+
limitations under the License.
16+
*/}}
317
Apache OpenWhisk
4-
Copyright 2016-2018 The Apache Software Foundation
18+
Copyright 2016-2020 The Apache Software Foundation
519

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

2438
To learn more about the release, try:
2539

26-
$ helm status {{ .Release.Name }} [--tls]
27-
$ helm get {{ .Release.Name }} [--tls]
40+
$ helm status {{ .Release.Name }}
41+
$ helm get {{ .Release.Name }}
2842

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

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

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

0 commit comments

Comments
 (0)