This is an automated email from the ASF dual-hosted git repository.
gyfora pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-kubernetes-operator.git
The following commit(s) were added to refs/heads/main by this push:
new 7ced741f [FLINK-28616][doc] Make quickstart versions references
dynamic based on site conf
7ced741f is described below
commit 7ced741f51a99f2093ce8a45c8c92879a247f836
Author: Gyula Fora <[email protected]>
AuthorDate: Thu Jul 21 11:04:45 2022 +0200
[FLINK-28616][doc] Make quickstart versions references dynamic based on
site conf
---
docs/content/docs/operations/helm.md | 2 +-
.../try-flink-kubernetes-operator/quick-start.md | 11 +++++++----
docs/layouts/shortcodes/stable_branch.html | 22 ++++++++++++++++++++++
3 files changed, 30 insertions(+), 5 deletions(-)
diff --git a/docs/content/docs/operations/helm.md
b/docs/content/docs/operations/helm.md
index 6a0b96ed..49378b84 100644
--- a/docs/content/docs/operations/helm.md
+++ b/docs/content/docs/operations/helm.md
@@ -47,7 +47,7 @@ Helm provides different ways to override the default
installation parameters (co
To override single parameters you can use `--set`, for example:
```
-helm install --set image.repository=apache/flink-kubernetes-operator --set
image.tag=1.0.1 flink-kubernetes-operator helm/flink-kubernetes-operator
+helm install --set image.repository=apache/flink-kubernetes-operator --set
image.tag={{< stable >}}{{< version >}}{{< /stable >}}{{< unstable >}}latest{{<
/unstable >}} flink-kubernetes-operator helm/flink-kubernetes-operator
```
You can also provide your custom values file by using the `-f` flag:
diff --git a/docs/content/docs/try-flink-kubernetes-operator/quick-start.md
b/docs/content/docs/try-flink-kubernetes-operator/quick-start.md
index 5ebd9cd7..f00f2960 100644
--- a/docs/content/docs/try-flink-kubernetes-operator/quick-start.md
+++ b/docs/content/docs/try-flink-kubernetes-operator/quick-start.md
@@ -73,12 +73,15 @@ kubectl create -f
https://github.com/jetstack/cert-manager/releases/download/v1.
In case the cert manager installation failed for any reason you can disable
the webhook by passing `--set webhook.create=false` to the helm install command
for the operator.
{{< /hint >}}
-Now you can deploy the latest stable Flink Kubernetes Operator version using
the included Helm chart:
+Now you can deploy the selected stable Flink Kubernetes Operator version using
the included Helm chart:
+
```bash
-helm repo add flink-operator-repo
https://downloads.apache.org/flink/flink-kubernetes-operator-1.0.1/
+helm repo add flink-operator-repo
https://downloads.apache.org/flink/flink-kubernetes-operator-{{< stable >}}{{<
version >}}{{< /stable >}}{{< unstable >}}<OPERATOR-VERSION>{{< /unstable
>}}/
helm install flink-kubernetes-operator
flink-operator-repo/flink-kubernetes-operator
```
+To find the list of stable versions please visit
https://flink.apache.org/downloads.html
+
{{< hint info >}}
The Helm chart by default points to the
`ghcr.io/apache/flink-kubernetes-operator` image repository.
If you have connectivity issues or prefer to use Dockerhub instead you can use
`--set image.repository=apache/flink-kubernetes-operator` during installation.
@@ -92,14 +95,14 @@ flink-kubernetes-operator-fb5d46f94-ghd8b 2/2 Running 0
4m21s
helm list
NAME NAMESPACE REVISION UPDATED STATUS CHART APP VERSION
-flink-kubernetes-operator default 1 2022-03-09 17
(tel:12022030917):39:55.461359 +0100 CET deployed
flink-kubernetes-operator-1.0.1 1.0.1
+flink-kubernetes-operator default 1 2022-03-09 17
(tel:12022030917):39:55.461359 +0100 CET deployed flink-kubernetes-operator-{{<
version >}} {{< version >}}
```
## Submitting a Flink job
Once the operator is running as seen in the previous step you are ready to
submit a Flink job:
```bash
-kubectl create -f
https://raw.githubusercontent.com/apache/flink-kubernetes-operator/release-1.0/examples/basic.yaml
+kubectl create -f
https://raw.githubusercontent.com/apache/flink-kubernetes-operator/{{<
stable_branch >}}/examples/basic.yaml
```
You may follow the logs of your job, after a successful startup (which can
take on the order of a minute in a fresh environment, seconds afterwards) you
can:
diff --git a/docs/layouts/shortcodes/stable_branch.html
b/docs/layouts/shortcodes/stable_branch.html
new file mode 100644
index 00000000..9e2e1f54
--- /dev/null
+++ b/docs/layouts/shortcodes/stable_branch.html
@@ -0,0 +1,22 @@
+{{/*
+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.
+*/}}{{/*
+ Shortcode that interpolates the stable version title
+
+ Parmeters: None
+*/}}{{ if $.Site.Params.IsStable }}{{- $.Site.Params.Branch
-}}{{else}}release-{{- index (index $.Site.Params.PreviousDocs 0) 0 -}}{{ end }}
\ No newline at end of file
