ulysses-you commented on a change in pull request #1457: URL: https://github.com/apache/incubator-kyuubi/pull/1457#discussion_r757873798
########## File path: docs/deployment/kyuubi_on_kubernetes.md ########## @@ -0,0 +1,98 @@ +<!-- + - 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. + --> + +<div align=center> + + + +</div> + +# Deploy Kyuubi On Kubernetes + +## Requirements + +If you want to deploy Kyuubi on Kubernetes, you'd better have cognition upon the following things. Review comment: `cognition` ? ########## File path: docs/deployment/kyuubi_on_kubernetes.md ########## @@ -0,0 +1,98 @@ +<!-- + - 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. + --> + +<div align=center> + + + +</div> + +# Deploy Kyuubi On Kubernetes + +## Requirements + +If you want to deploy Kyuubi on Kubernetes, you'd better have cognition upon the following things. + +* Use Kyuubi official docker image or build Kyuubi docker image +* An active Kubernetes cluster +* Reading About [Deploy Kyuubi engines on Kubernetes](https://kyuubi.readthedocs.io/en/latest/deployment/egine_on_kubernetes.html) +* [Kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) +* KubeConfig of the target cluster + +## Kyuubi Official Docker Image + +You can find official docker image here [Apache Kyuubi Docker Hub](https://registry.hub.docker.com/r/apache/kyuubi). + +## Build Kyuubi Docker Image + +You can build custom Docker images from the `${KYUUBI_HOME}/bin/docker-image-tool.sh` contained in the binary package. + +Examples: +```shell + - Build and push image with tag "v1.4.0" to docker.io/myrepo + $0 -r docker.io/myrepo -t v1.4.0 build + $0 -r docker.io/myrepo -t v1.4.0 push + + - Build and push with tag "v3.0.0" and Spark-3.1.2 as base image to docker.io/myrepo + $0 -r docker.io/myrepo -t v3.0.0 -b BASE_IMAGE=repo/spark:3.1.2 build + $0 -r docker.io/myrepo -t v3.0.0 push + + - Build and push for multiple archs to docker.io/myrepo + $0 -r docker.io/myrepo -t v3.0.0 -X build + + - Build with Spark placed "/path/spark" + $0 -s /path/spark build +``` + +`${KYUUBI_HOME}/bin/docker-image-tool.sh` use `Kyuubi Version` as default docker tag and always build `${repo}/kyuubi:${tag}` image. + +The script can also help build external Spark into a Kyuubi image that acts as a client for submitting tasks by `-s ${SPAAK_HOME`. Review comment: `${SPAAK_HOME` -> `${SPAAK_HOME}` ########## File path: docs/deployment/kyuubi_on_kubernetes.md ########## @@ -0,0 +1,98 @@ +<!-- + - 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. + --> + +<div align=center> + + + +</div> + +# Deploy Kyuubi On Kubernetes + +## Requirements + +If you want to deploy Kyuubi on Kubernetes, you'd better have cognition upon the following things. + +* Use Kyuubi official docker image or build Kyuubi docker image +* An active Kubernetes cluster +* Reading About [Deploy Kyuubi engines on Kubernetes](https://kyuubi.readthedocs.io/en/latest/deployment/egine_on_kubernetes.html) +* [Kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) +* KubeConfig of the target cluster + +## Kyuubi Official Docker Image + +You can find official docker image here [Apache Kyuubi Docker Hub](https://registry.hub.docker.com/r/apache/kyuubi). + +## Build Kyuubi Docker Image + +You can build custom Docker images from the `${KYUUBI_HOME}/bin/docker-image-tool.sh` contained in the binary package. + +Examples: +```shell + - Build and push image with tag "v1.4.0" to docker.io/myrepo + $0 -r docker.io/myrepo -t v1.4.0 build + $0 -r docker.io/myrepo -t v1.4.0 push + + - Build and push with tag "v3.0.0" and Spark-3.1.2 as base image to docker.io/myrepo + $0 -r docker.io/myrepo -t v3.0.0 -b BASE_IMAGE=repo/spark:3.1.2 build + $0 -r docker.io/myrepo -t v3.0.0 push + + - Build and push for multiple archs to docker.io/myrepo + $0 -r docker.io/myrepo -t v3.0.0 -X build + + - Build with Spark placed "/path/spark" + $0 -s /path/spark build +``` + +`${KYUUBI_HOME}/bin/docker-image-tool.sh` use `Kyuubi Version` as default docker tag and always build `${repo}/kyuubi:${tag}` image. + +The script can also help build external Spark into a Kyuubi image that acts as a client for submitting tasks by `-s ${SPAAK_HOME`. + +## Deploy + +Multiple YAML files are provided under `${KYUUBI_HOME}/docker/` to help you deploy Kyuubi. + +You can deploy single-node Kyuubi through `${KYUUBI_HOME/docker/kyuubi-pod.yaml}` or `${KYUUBI_HOME/docker/kyuubi-deployment.yaml}`. + +Also, you can use `${KYUUBI_HOME/docker/kyuubi-service.yaml}` deploy Kyuubi Service. Review comment: ditto ########## File path: docs/deployment/kyuubi_on_kubernetes.md ########## @@ -0,0 +1,98 @@ +<!-- + - 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. + --> + +<div align=center> + + + +</div> + +# Deploy Kyuubi On Kubernetes + +## Requirements + +If you want to deploy Kyuubi on Kubernetes, you'd better have cognition upon the following things. + +* Use Kyuubi official docker image or build Kyuubi docker image +* An active Kubernetes cluster +* Reading About [Deploy Kyuubi engines on Kubernetes](https://kyuubi.readthedocs.io/en/latest/deployment/egine_on_kubernetes.html) +* [Kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) +* KubeConfig of the target cluster + +## Kyuubi Official Docker Image + +You can find official docker image here [Apache Kyuubi Docker Hub](https://registry.hub.docker.com/r/apache/kyuubi). + +## Build Kyuubi Docker Image + +You can build custom Docker images from the `${KYUUBI_HOME}/bin/docker-image-tool.sh` contained in the binary package. + +Examples: +```shell + - Build and push image with tag "v1.4.0" to docker.io/myrepo + $0 -r docker.io/myrepo -t v1.4.0 build + $0 -r docker.io/myrepo -t v1.4.0 push + + - Build and push with tag "v3.0.0" and Spark-3.1.2 as base image to docker.io/myrepo + $0 -r docker.io/myrepo -t v3.0.0 -b BASE_IMAGE=repo/spark:3.1.2 build + $0 -r docker.io/myrepo -t v3.0.0 push + + - Build and push for multiple archs to docker.io/myrepo + $0 -r docker.io/myrepo -t v3.0.0 -X build + + - Build with Spark placed "/path/spark" + $0 -s /path/spark build +``` + +`${KYUUBI_HOME}/bin/docker-image-tool.sh` use `Kyuubi Version` as default docker tag and always build `${repo}/kyuubi:${tag}` image. + +The script can also help build external Spark into a Kyuubi image that acts as a client for submitting tasks by `-s ${SPAAK_HOME`. + +## Deploy + +Multiple YAML files are provided under `${KYUUBI_HOME}/docker/` to help you deploy Kyuubi. + +You can deploy single-node Kyuubi through `${KYUUBI_HOME/docker/kyuubi-pod.yaml}` or `${KYUUBI_HOME/docker/kyuubi-deployment.yaml}`. + +Also, you can use `${KYUUBI_HOME/docker/kyuubi-service.yaml}` deploy Kyuubi Service. + +## Config + +You can configure Kyuubi the old-fashioned way by placing kyuubi-default.conf inside the image. Kyuubi do not recommend using this way on Kubernetes. + +Kyuubi provide `${KYUUBI_HOME/docker/kyuubi-configmap.yaml}` to build Configmap for Kyuubi. + +You can find out how to use it in the comments inside the above file. + +If you want to know kyuubi engine on kubernetes configurations, you can refer to [Deploy Kyuubi engines on Kubernetes](https://kyuubi.readthedocs.io/en/latest/deployment/egine_on_kubernetes.html) + +## Connect + +If you do not use Service or HostNetwork to get the IP address of the node where Kyuubi resides. Review comment: `resides` -> `deployed ` ########## File path: docs/deployment/kyuubi_on_kubernetes.md ########## @@ -0,0 +1,98 @@ +<!-- + - 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. + --> + +<div align=center> + + + +</div> + +# Deploy Kyuubi On Kubernetes + +## Requirements + +If you want to deploy Kyuubi on Kubernetes, you'd better have cognition upon the following things. + +* Use Kyuubi official docker image or build Kyuubi docker image +* An active Kubernetes cluster +* Reading About [Deploy Kyuubi engines on Kubernetes](https://kyuubi.readthedocs.io/en/latest/deployment/egine_on_kubernetes.html) +* [Kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) +* KubeConfig of the target cluster + +## Kyuubi Official Docker Image + +You can find official docker image here [Apache Kyuubi Docker Hub](https://registry.hub.docker.com/r/apache/kyuubi). + +## Build Kyuubi Docker Image + +You can build custom Docker images from the `${KYUUBI_HOME}/bin/docker-image-tool.sh` contained in the binary package. + +Examples: +```shell + - Build and push image with tag "v1.4.0" to docker.io/myrepo + $0 -r docker.io/myrepo -t v1.4.0 build + $0 -r docker.io/myrepo -t v1.4.0 push + + - Build and push with tag "v3.0.0" and Spark-3.1.2 as base image to docker.io/myrepo + $0 -r docker.io/myrepo -t v3.0.0 -b BASE_IMAGE=repo/spark:3.1.2 build + $0 -r docker.io/myrepo -t v3.0.0 push + + - Build and push for multiple archs to docker.io/myrepo + $0 -r docker.io/myrepo -t v3.0.0 -X build + + - Build with Spark placed "/path/spark" + $0 -s /path/spark build +``` + +`${KYUUBI_HOME}/bin/docker-image-tool.sh` use `Kyuubi Version` as default docker tag and always build `${repo}/kyuubi:${tag}` image. + +The script can also help build external Spark into a Kyuubi image that acts as a client for submitting tasks by `-s ${SPAAK_HOME`. + +## Deploy + +Multiple YAML files are provided under `${KYUUBI_HOME}/docker/` to help you deploy Kyuubi. + +You can deploy single-node Kyuubi through `${KYUUBI_HOME/docker/kyuubi-pod.yaml}` or `${KYUUBI_HOME/docker/kyuubi-deployment.yaml}`. Review comment: `${KYUUBI_HOME}/docker/kyuubi-pod.yaml` ? ########## File path: docs/deployment/kyuubi_on_kubernetes.md ########## @@ -0,0 +1,98 @@ +<!-- + - 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. + --> + +<div align=center> + + + +</div> + +# Deploy Kyuubi On Kubernetes + +## Requirements + +If you want to deploy Kyuubi on Kubernetes, you'd better have cognition upon the following things. + +* Use Kyuubi official docker image or build Kyuubi docker image +* An active Kubernetes cluster +* Reading About [Deploy Kyuubi engines on Kubernetes](https://kyuubi.readthedocs.io/en/latest/deployment/egine_on_kubernetes.html) +* [Kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) +* KubeConfig of the target cluster + +## Kyuubi Official Docker Image + +You can find official docker image here [Apache Kyuubi Docker Hub](https://registry.hub.docker.com/r/apache/kyuubi). + +## Build Kyuubi Docker Image + +You can build custom Docker images from the `${KYUUBI_HOME}/bin/docker-image-tool.sh` contained in the binary package. + +Examples: +```shell + - Build and push image with tag "v1.4.0" to docker.io/myrepo + $0 -r docker.io/myrepo -t v1.4.0 build + $0 -r docker.io/myrepo -t v1.4.0 push + + - Build and push with tag "v3.0.0" and Spark-3.1.2 as base image to docker.io/myrepo + $0 -r docker.io/myrepo -t v3.0.0 -b BASE_IMAGE=repo/spark:3.1.2 build + $0 -r docker.io/myrepo -t v3.0.0 push + + - Build and push for multiple archs to docker.io/myrepo + $0 -r docker.io/myrepo -t v3.0.0 -X build + + - Build with Spark placed "/path/spark" + $0 -s /path/spark build +``` + +`${KYUUBI_HOME}/bin/docker-image-tool.sh` use `Kyuubi Version` as default docker tag and always build `${repo}/kyuubi:${tag}` image. + +The script can also help build external Spark into a Kyuubi image that acts as a client for submitting tasks by `-s ${SPAAK_HOME`. + +## Deploy + +Multiple YAML files are provided under `${KYUUBI_HOME}/docker/` to help you deploy Kyuubi. + +You can deploy single-node Kyuubi through `${KYUUBI_HOME/docker/kyuubi-pod.yaml}` or `${KYUUBI_HOME/docker/kyuubi-deployment.yaml}`. + +Also, you can use `${KYUUBI_HOME/docker/kyuubi-service.yaml}` deploy Kyuubi Service. + +## Config + +You can configure Kyuubi the old-fashioned way by placing kyuubi-default.conf inside the image. Kyuubi do not recommend using this way on Kubernetes. + +Kyuubi provide `${KYUUBI_HOME/docker/kyuubi-configmap.yaml}` to build Configmap for Kyuubi. Review comment: ditto ########## File path: docs/deployment/kyuubi_on_kubernetes.md ########## @@ -0,0 +1,98 @@ +<!-- + - 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. + --> + +<div align=center> + + + +</div> + +# Deploy Kyuubi On Kubernetes + +## Requirements + +If you want to deploy Kyuubi on Kubernetes, you'd better have cognition upon the following things. + +* Use Kyuubi official docker image or build Kyuubi docker image +* An active Kubernetes cluster +* Reading About [Deploy Kyuubi engines on Kubernetes](https://kyuubi.readthedocs.io/en/latest/deployment/egine_on_kubernetes.html) +* [Kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) +* KubeConfig of the target cluster + +## Kyuubi Official Docker Image + +You can find official docker image here [Apache Kyuubi Docker Hub](https://registry.hub.docker.com/r/apache/kyuubi). Review comment: `Apache Kyuubi ` -> `Apache Kyuubi (Incubating)` -- 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]
