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 22a7f37 [FLINK-26707] Rework README
22a7f37 is described below
commit 22a7f377e5e1b67dbf761854b53e0f680a79673e
Author: Gyula Fora <[email protected]>
AuthorDate: Fri Mar 18 14:22:27 2022 +0100
[FLINK-26707] Rework README
---
README.md | 78 ++++++++-------------------------
docs/content/docs/operations/helm.md | 29 ++++++++++++
docs/content/docs/operations/webhook.md | 27 ------------
3 files changed, 47 insertions(+), 87 deletions(-)
diff --git a/README.md b/README.md
index d5e8336..41bf0c1 100644
--- a/README.md
+++ b/README.md
@@ -1,75 +1,33 @@
# Apache Flink Kubernetes Operator
-A Kubernetes operator for Apache Flink, implemented in Java. See
[FLIP-212](https://cwiki.apache.org/confluence/display/FLINK/FLIP-212%3A+Introduce+Flink+Kubernetes+Operator).
+A Kubernetes operator for Apache Flink, implemented in Java. It allows users
to manage Flink applications and their lifecycle through native k8s tooling
like kubectl.
-## Documentation
+## Documentation & Getting Started
-Our full
[documentation](https://nightlies.apache.org/flink/flink-kubernetes-operator-docs-main/)
is hosted by the
-[ASF](https://www.apache.org/), please check out details there as this
document only describes the basics.
+Please check out the full
[documentation](https://nightlies.apache.org/flink/flink-kubernetes-operator-docs-main/),
hosted by the
+[ASF](https://www.apache.org/), for detailed information and user guides.
-## Installation
+Check our
[quick-start](https://nightlies.apache.org/flink/flink-kubernetes-operator-docs-main/docs/try-flink-kubernetes-operator/quick-start/)
guide for simple setup instructions to get you started with the operator.
-The operator installation is managed by a helm chart. To install run:
+## Features at a glance
-```
-helm install flink-operator helm/flink-operator
-```
+ - Deploy and monitor Flink Application and Session deployments
+ - Upgrade, suspend and delete deployments
+ - Full logging and metrics integration
+ - Flexible deployments and native integration with Kubernetes tooling
-Alternatively to install the operator (and also the helm chart) to a specific
namespace:
+## Support
-```
-helm install flink-operator helm/flink-operator --namespace flink-operator
--create-namespace
-```
+Don’t hesitate to ask!
-Note that in this case you will need to update the namespace in the examples
accordingly or the `default`
-namespace to the [watched namespaces](#watching-only-specific-namespaces).
+Contact the developers and community on the [mailing
lists](https://flink.apache.org/community.html#mailing-lists) if you need any
help.
-### Validating webhook
+[Open an issue](https://issues.apache.org/jira/browse/FLINK) if you found a
bug in Flink.
-In order to use the webhook for FlinkDeployment validation, you must install
the cert-manager on the Kubernetes cluster:
-```
-kubectl apply -f
https://github.com/jetstack/cert-manager/releases/download/v1.7.1/cert-manager.yaml
-```
+## Contributing
-The webhook can be disabled during helm install by passing the `--set
webhook.create=false` parameter or editing the `values.yaml` directly.
+You can learn more about how to contribute in the [Apache Flink
website](https://flink.apache.org/contributing/how-to-contribute.html). For
code contributions, please read carefully the [Contributing
Code](https://flink.apache.org/contributing/contribute-code.html) section for
an overview of ongoing community work.
-### Watching only specific namespaces
+## License
-The operator supports watching a specific list of namespaces for
FlinkDeployment resources. You can enable it by setting the `--set
watchNamespaces={flink-test}` parameter.
-When this is enabled role-based access control is only created specifically
for these namespaces for the operator and the jobmanagers, otherwise it
defaults to cluster scope.
-
-## User Guide
-### Create a new Flink deployment
-The flink-operator will watch the CRD resources and submit a new Flink
deployment once the CR is applied.
-```
-kubectl create -f examples/basic.yaml
-```
-
-### Delete a Flink deployment
-```
-kubectl delete -f examples/basic.yaml
-
-OR
-
-kubectl delete flinkdep {dep_name}
-```
-
-### Get/List Flink deployments
-Get all the Flink deployments running in the K8s cluster
-```
-kubectl get flinkdep
-```
-Describe a specific Flink deployment to show the status(including job status,
savepoint, etc.)
-```
-kubectl describe flinkdep {dep_name}
-```
-
-## CI/CD
-We use [GitHub
Actions](https://help.github.com/en/actions/getting-started-with-github-actions/about-github-actions)
to help you automate your software development workflows in the same place you
store code and collaborate on pull requests and issues.
-You can write individual tasks, called actions, and combine them to create a
custom workflow.
-Workflows are custom automated processes that you can set up in your
repository to build, test, package, release, or deploy any code project on
GitHub.
-
-Considering the cost of running the builds, the stability, and the
maintainability, flink-kubernetes-operator chose GitHub Actions and build the
whole CI/CD solution on it.
-All the unit tests, integration tests, and the end-to-end tests will be
triggered for each PR.
-
-Note: Please make sure the CI passed before merging.
\ No newline at end of file
+The code in this repository is licensed under the [Apache Software License
2](LICENSE).
diff --git a/docs/content/docs/operations/helm.md
b/docs/content/docs/operations/helm.md
index 34a1e95..bd6d131 100644
--- a/docs/content/docs/operations/helm.md
+++ b/docs/content/docs/operations/helm.md
@@ -25,3 +25,32 @@ under the License.
-->
# Helm installation
+
+The operator installation is managed by a helm chart. To install run:
+
+```
+helm install flink-operator helm/flink-operator
+```
+
+Alternatively to install the operator (and also the helm chart) to a specific
namespace:
+
+```
+helm install flink-operator helm/flink-operator --namespace flink-operator
--create-namespace
+```
+
+Note that in this case you will need to update the namespace in the examples
accordingly or the `default`
+namespace to the [watched namespaces](#watching-only-specific-namespaces).
+
+## Validating webhook
+
+In order to use the webhook for FlinkDeployment validation, you must install
the cert-manager on the Kubernetes cluster:
+```
+kubectl apply -f
https://github.com/jetstack/cert-manager/releases/download/v1.7.1/cert-manager.yaml
+```
+
+The webhook can be disabled during helm install by passing the `--set
webhook.create=false` parameter or editing the `values.yaml` directly.
+
+## Watching only specific namespaces
+
+The operator supports watching a specific list of namespaces for
FlinkDeployment resources. You can enable it by setting the `--set
watchNamespaces={flink-test}` parameter.
+When this is enabled role-based access control is only created specifically
for these namespaces for the operator and the jobmanagers, otherwise it
defaults to cluster scope.
diff --git a/docs/content/docs/operations/webhook.md
b/docs/content/docs/operations/webhook.md
deleted file mode 100644
index 5804a0b..0000000
--- a/docs/content/docs/operations/webhook.md
+++ /dev/null
@@ -1,27 +0,0 @@
----
-title: "Webhook"
-weight: 5
-type: docs
-aliases:
-- /operations/webhook.html
----
-<!--
-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.
--->
-
-# Webhook
