martin-g commented on a change in pull request #1: URL: https://github.com/apache/flink-kubernetes-operator/pull/1#discussion_r806600983
########## File path: README.md ########## @@ -1,2 +1,69 @@ # flink-kubernetes-operator -Apache Flink Kubernetes Operator +Temporary repository for Flink Kubernetes Operator. The content will be moved to OSS repo once created an IPR. Check [FLIP-212](https://cwiki.apache.org/confluence/display/FLINK/FLIP-212%3A+Introduce+Flink+Kubernetes+Operator) further info. + +## Installation + +The operator is managed helm chart. To install run: +``` + cd helm/flink-operator + helm install flink-operator . +``` + +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. + +## User Guide +### Create a new Flink deployment +The flink-operator will watch the CRD resources and submit a new Flink deployment once the CR it applied. Review comment: `... is applied` ? ########## File path: README.md ########## @@ -1,2 +1,69 @@ # flink-kubernetes-operator -Apache Flink Kubernetes Operator +Temporary repository for Flink Kubernetes Operator. The content will be moved to OSS repo once created an IPR. Check [FLIP-212](https://cwiki.apache.org/confluence/display/FLINK/FLIP-212%3A+Introduce+Flink+Kubernetes+Operator) further info. + +## Installation + +The operator is managed helm chart. To install run: +``` + cd helm/flink-operator + helm install flink-operator . +``` + +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. + +## User Guide +### Create a new Flink deployment +The flink-operator will watch the CRD resources and submit a new Flink deployment once the CR it applied. +``` +kubectl create -f examples/basic.yaml +``` + +### Delete a Flink deployment +``` +kubectl delete -f create/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, ect.) Review comment: s/ect/etc/ ########## File path: README.md ########## @@ -1,2 +1,69 @@ # flink-kubernetes-operator -Apache Flink Kubernetes Operator +Temporary repository for Flink Kubernetes Operator. The content will be moved to OSS repo once created an IPR. Check [FLIP-212](https://cwiki.apache.org/confluence/display/FLINK/FLIP-212%3A+Introduce+Flink+Kubernetes+Operator) further info. + +## Installation + +The operator is managed helm chart. To install run: +``` + cd helm/flink-operator + helm install flink-operator . +``` + +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. + +## User Guide +### Create a new Flink deployment +The flink-operator will watch the CRD resources and submit a new Flink deployment once the CR it applied. +``` +kubectl create -f examples/basic.yaml +``` + +### Delete a Flink deployment +``` +kubectl delete -f create/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, ect.) +``` +kubectl describe flinkdep {dep_name} +``` +## Developer Guide + +### Building docker images +``` +docker build . -t <repo>/flink-java-operator:latest +docker push <repo>flink-java-operator:latest +helm install flink-operator . --set image.repository=<repo> --set image.tag=latest +``` +### Running the operator locally +You can run or debug the `FlinkOperator` from your preferred IDE. The operator itself is accessing the deployed Flink clusters through the REST interface. When running locally the `rest.port` and `rest.address` Flink configuration parameters must be modified to a locally accessible value. + +When using `minikube tunnel` the rest service is exposed on `localhost:8081` +``` +> minikube tunnel + +> kubectl get services +NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE +basic-session-example ClusterIP None <none> 6123/TCP,6124/TCP 14h +basic-session-example-rest LoadBalancer 10.96.36.250 127.0.0.1 8081:30572/TCP 14h +``` +The operator pics up the default log and flink configurations from `/opt/flink/conf`. You can put the rest configuration parameters here: Review comment: s/pics/picks/ ########## File path: pom.xml ########## @@ -0,0 +1,286 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +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. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd";> + + <parent> + <groupId>org.apache</groupId> + <artifactId>apache</artifactId> + <version>20</version> + </parent> + + <modelVersion>4.0.0</modelVersion> + + <groupId>org.apache.flink</groupId> + <artifactId>flink-kubernetes-operator-parent</artifactId> + <version>1.0-SNAPSHOT</version> + + <name>Flink Kubernetes: </name> + <packaging>pom</packaging> + <url>https://flink.apache.org</url> + <inceptionYear>2014</inceptionYear> + + <licenses> + <license> + <name>The Apache Software License, Version 2.0</name> + <url>https://www.apache.org/licenses/LICENSE-2.0.txt</url> + <distribution>repo</distribution> + </license> + </licenses> + + <modules> + <module>flink-kubernetes-operator</module> + <module>flink-kubernetes-webhook</module> + </modules> + + <properties> + <maven.compiler.source>1.8</maven.compiler.source> + <maven.compiler.target>1.8</maven.compiler.target> + <maven-assembly-plugin.version>3.3.0</maven-assembly-plugin.version> + <maven-surefire-plugin.version>3.0.0-M4</maven-surefire-plugin.version> + <maven-failsafe-plugin.version>3.0.0-M4</maven-failsafe-plugin.version> + <maven-resources-plugin.version>3.2.0</maven-resources-plugin.version> + + <operator.sdk.version>2.0.1</operator.sdk.version> + <fabric8.version>5.12.1</fabric8.version> + <lombok.version>1.18.22</lombok.version> + + <scala.version>2.12</scala.version> + <flink.version>1.14.3</flink.version> + <flink.shaded.version>15.0</flink.shaded.version> + + <slf4j.version>1.7.15</slf4j.version> + <log4j.version>2.17.1</log4j.version> + + <spotless.version>2.4.2</spotless.version> + <awaitility.version>4.1.0</awaitility.version> + <it.skip>true</it.skip> + <mockito.version>2.21.0</mockito.version> Review comment: Why such old Mockito version ? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
