You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by nf...@apache.org on 2020/02/21 08:25:35 UTC
[camel-k] 03/04: Fix #167: add readme and release script
This is an automated email from the ASF dual-hosted git repository.
nferraro pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel-k.git
commit 819dbd98acad7207197a6eb3fafa320a36e7bcd3
Author: Nicola Ferraro <ni...@gmail.com>
AuthorDate: Thu Feb 20 23:48:54 2020 +0100
Fix #167: add readme and release script
---
helm/camel-k/README.md | 88 ++++++++++++++++++++++++++++++++++++++++++++++++
helm/camel-k/values.yaml | 5 ---
script/Makefile | 5 ++-
script/release_helm.sh | 27 +++++++++++++++
4 files changed, 119 insertions(+), 6 deletions(-)
diff --git a/helm/camel-k/README.md b/helm/camel-k/README.md
new file mode 100644
index 0000000..a50cc3a
--- /dev/null
+++ b/helm/camel-k/README.md
@@ -0,0 +1,88 @@
+# Camel K
+
+Apache Camel K is a lightweight integration platform, born on Kubernetes,
+with serverless superpowers.
+
+This chart deploys the Camel K operator and all resources needed to natively run
+Apache Camel integrations on any Kubernetes cluster.
+
+## Prerequisites
+
+- Kubernetes 1.11+
+- Container Image Registry installed and configured for pull
+
+## Installing the Chart
+
+To install the chart, first add the Camel K repository:
+
+```bash
+$ helm repo add camel-k https://apache.github.io/camel-k/helm/charts
+```
+
+If you are installing on OpenShift, Camel K can use the OpenShift internal registry to
+store and pull images.
+
+Installation on OpenShift can be done with command:
+
+```bash
+$ helm install \
+ --generate-name \
+ camel-k/camel-k
+```
+
+When running on a cluster with no embedded internal registry, you need to specify the address
+and properties of an image registry that the cluster can use to store image.
+
+For example, on Minikube you can enable the internal registry and get its address:
+
+```bash
+$ minikube addons enable registry
+$ export REGISTRY_ADDRESS=$(kubectl -n kube-system get service registry -o jsonpath='{.spec.clusterIP}')
+```
+
+Then you can install Camel K with:
+
+```bash
+$ helm install \
+ --generate-name \
+ --set platform.build.registry.address=${REGISTRY_ADDRESS}
+ --set platform.build.registry.insecure=true \
+ camel-k/camel-k
+```
+
+The [configuration](#configuration) section lists
+additional parameters that can be set during installation.
+
+> **Tip**: List all releases using `helm list`
+
+## Uninstalling the Chart
+
+To uninstall/delete the `camel-k` Deployment:
+
+```bash
+$ helm delete camel-k
+```
+
+The command removes all the Kubernetes resources installed.
+
+## Configuration
+
+The following table lists the most commonly configured parameters of the
+CouchDB chart and their default values:
+
+| Parameter | Description | Default |
+|------------------------------------|-------------------------------------------------------------|----------------------------------------|
+| `platform.build.registry.address` | The address of a container image registry to push images | |
+| `platform.build.registry.insecure` | Indicates if the registry is secured | true |
+| `platform.cluster` | The kind of Kubernetes cluster (Kubernetes or OpenShift) | `Kubernetes` |
+| `platform.profile` | The trait profile to use (Knative, Kubernetes or OpenShift) | auto |
+
+## Contributing
+
+We'd like to hear your feedback and we love any kind of contribution!
+
+The main contact points for the Camel K project are the [GitHub repository][1]
+and the [Gitter room][2].
+
+[1]: https://github.com/apache/camel-k
+[2]: https://gitter.im/apache/camel-k
diff --git a/helm/camel-k/values.yaml b/helm/camel-k/values.yaml
index 814b797..312ae16 100644
--- a/helm/camel-k/values.yaml
+++ b/helm/camel-k/values.yaml
@@ -5,10 +5,5 @@
nameOverride: ""
fullnameOverride: ""
-platform:
- build:
- registry:
- insecure: false
-
operator:
image: docker.io/apache/camel-k:1.0.0-RC2-SNAPSHOT
diff --git a/script/Makefile b/script/Makefile
index 4bb84b5..35c8b5f 100644
--- a/script/Makefile
+++ b/script/Makefile
@@ -226,6 +226,9 @@ release: clean codegen set-version build-resources check-licenses unsnapshot-olm
release-staging: clean codegen set-version build-resources check-licenses unsnapshot-olm build images images-push-staging cross-compile package-examples git-tag
+release-helm:
+ ./script/release_helm.sh
+
install-minishift:
./script/install_minishift.sh
install-minikube:
@@ -234,4 +237,4 @@ install-minikube:
release-notes:
./script/gen_release_notes.sh $(LAST_RELEASED_VERSION) $(VERSION)
-.PHONY: build build-kamel build-resources build-olm unsnapshot-olm dep codegen images images-dev images-push images-push-staging test check test-integration clean release cross-compile package-examples set-version git-tag release-notes check-licenses generate-deepcopy generate-client generate-doc build-resources
+.PHONY: build build-kamel build-resources build-olm unsnapshot-olm dep codegen images images-dev images-push images-push-staging test check test-integration clean release cross-compile package-examples set-version git-tag release-notes check-licenses generate-deepcopy generate-client generate-doc build-resources release-helm
diff --git a/script/release_helm.sh b/script/release_helm.sh
new file mode 100755
index 0000000..61cf9ec
--- /dev/null
+++ b/script/release_helm.sh
@@ -0,0 +1,27 @@
+#!/bin/sh
+
+# 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.
+
+location=$(dirname $0)
+rootdir=$location/../
+
+cd $rootdir/helm
+
+mkdir -p charts
+
+helm package ./camel-k
+mv camel-k-*.tgz charts
+helm repo index charts --url https://camel-k.github.io/helm/charts