Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nineinfra/kyuubi-operator
This is a Kubernetes Operator to manage Apache Kyuubi
https://github.com/nineinfra/kyuubi-operator
kubernetes kyuubi operator
Last synced: about 2 months ago
JSON representation
This is a Kubernetes Operator to manage Apache Kyuubi
- Host: GitHub
- URL: https://github.com/nineinfra/kyuubi-operator
- Owner: nineinfra
- License: apache-2.0
- Created: 2023-09-22T11:50:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-21T02:26:22.000Z (10 months ago)
- Last Synced: 2024-03-21T17:32:00.523Z (10 months ago)
- Topics: kubernetes, kyuubi, operator
- Language: Go
- Homepage: https://nineinfra.github.io/kyuubi-operator/
- Size: 10.8 MB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# kyuubi-operator
This is a Kubernetes Operator to manage Apache Kyuubi.
## Description
The kyuubi-operator is an important part of the NineInfra Data Platform, a curated combination of open-source projects
including Spark, Flink, Minio, Kafka, ClickHouse, Kyuubi, and Superset, all working together seamlessly to provide users
with a stable and user-friendly big data processing platform. Nineinfra is a full-stack data platform built on Kubernetes,
capable of running on public cloud, private cloud, or on-premises environments.
## Getting Started
You’ll need a Kubernetes cluster to run against. You can use [KIND](https://sigs.k8s.io/kind) to get a local cluster for testing, or run against a remote cluster.
**Note:** Your controller will automatically use the current context in your kubeconfig file (i.e. whatever cluster `kubectl cluster-info` shows).
### Installing on a kubernetes cluster
Install kyuubi operator by helm:
```sh
helm repo add nineinfra-charts https://nineinfra.github.io/nineinfra-charts/
kubectl create namespace kyuubi-operator
helm install kyuubi-operator nineinfra-charts/kyuubi-operator -n kyuubi-operator
```
### Deploying a kyuubi cluster by kyuubi-operator
1. Obtain the necessary configuration information, including HDFS cluster, Metastore cluster, and Spark cluster configuration information.
example:
```sh
kubectl get svc -n dwh |grep hdfs
hdfs ClusterIP 10.100.208.68 9820/TCP,9870/TCP,9871/TCP
kubectl get svc -n dwh |grep metastore
hive-metastore ClusterIP 10.100.90.209 9083/TCP
```
And the service of hdfs is hdfs with the suffix .dwh.svc,the service of the metastore is the hive-metastore with the suffix .dwh.svc
2. Edit the cr yaml, there is a sample file like config/samples/kyuubi_v1alpha1_kyuubicluster.yaml
```yaml
apiVersion: kyuubi.nineinfra.tech/v1alpha1
kind: KyuubiCluster
metadata:
labels:
app.kubernetes.io/name: kyuubicluster
app.kubernetes.io/instance: kyuubicluster-sample
app.kubernetes.io/part-of: kyuubi-operator
app.kubernetes.io/managed-by: kustomize
app.kubernetes.io/created-by: kyuubi-operator
name: kyuubicluster-sample
spec:
kyuubiVersion: 1.8.1
kyuubiImage:
repository: nineinfra/kyuubi
tag: v1.8.1
kyuubiResource:
replicas: 1
kyuubiConf:
kyuubi.kubernetes.namespace: dwh
kyuubi.frontend.connection.url.use.hostname: 'false'
kyuubi.frontend.thrift.binary.bind.port: '10009'
kyuubi.frontend.thrift.http.bind.port: '10010'
kyuubi.frontend.rest.bind.port: '10099'
kyuubi.frontend.mysql.bind.port: '3309'
kyuubi.frontend.protocols: REST,THRIFT_BINARY
kyuubi.metrics.enabled: 'false'
clusterRefs:
- name: spark
type: spark
spark:
sparkMaster: k8s
sparkImage:
repository: nineinfra/spark
tag: v3.2.4
sparkNamespace: dwh
- name: hdfs
type: hdfs
hdfs:
coreSite:
fs.defaultFS: hdfs://hdfs.dwh.svc:9820
hdfsSite:
dfs.client.block.write.retries: '3'
- name: metastore
type: metastore
metastore:
hiveSite:
hive.metastore.uris: thrift://hive-metastore.dwh.svc:9083
hive.metastore.warehouse.dir: /user/hive/warehouse
```
3. Deploy a kyuubi cluster
```sh
kubectl apply -f kyuubi_v1alpha1_kyuubicluster.yaml -n kyuubi-operator
```
4. Get status of the kyuubi cluster,you can access the kyuubi cluster with the service in the output
```sh
kubectl get kyuubicluster kyuubicluster-sample -n kyuubi-operator -o yaml
status:
creationTime: "2023-09-28T06:11:18Z"
exposedInfos:
- exposedType: rest
name: kyuubicluster-sample-0
serviceName: kyuubicluster-sample-kyuubi
servicePort:
name: rest
port: 10099
protocol: TCP
targetPort: 10099
- exposedType: thrift-binary
name: kyuubicluster-sample-1
serviceName: kyuubicluster-sample-kyuubi
servicePort:
name: thrift-binary
port: 10009
protocol: TCP
targetPort: 10009
updateTime: "2023-09-28T06:11:18Z"
```
### Executing some example sql statements
1. Login the kyuubi pod
```sh
kubectl get pod -n kyuubi-operator
NAME READY STATUS RESTARTS AGE
kyuubi-kyuubi-user-spark-sql-anonymous-default-2f33bda8-a9b0-4584-a726-1d653c809d15-2f33bda8-a9b0-4584-a726-1d653c809d15-exec-1 0/1 Completed 0 92m
kyuubi-kyuubi-user-spark-sql-anonymous-default-2f33bda8-a9b0-4584-a726-1d653c809d15-2f33bda8-a9b0-4584-a726-1d653c809d15-exec-2 0/1 Completed 0 92m
kyuubi-operator-deployment-57b54cbc6-fc8bz 1/1 Running 0 85m
kyuubicluster-sample-kyuubi-0 1/1 Running 0 83m
kubectl exec -it kyuubicluster-sample-kyuubi-0 -n kyuubi-operator -- bash
```
2. Run beeline command
```sh
kyuubi@kyuubicluster-sample-kyuubi-0:/opt/kyuubi$ cd bin
kyuubi@kyuubicluster-sample-kyuubi-0:/opt/kyuubi/bin$ ./beeline
Warn: Not find kyuubi environment file /opt/kyuubi/conf/kyuubi-env.sh, using default ones...
Beeline version 1.8.0-SNAPSHOT by Apache Kyuubi
beeline>
```
3. Connect the kyuubi cluster by the thrift-binary protocol through the service kyuubicluster-sample-kyuubi
```sh
beeline> !connect jdbc:hive2://kyuubicluster-sample-kyuubi:10009
```
4. Execute some example sql statements
```sh
0: jdbc:hive2://kyuubicluster-sample-kyuubi:1> show databases;
+------------+
| namespace |
+------------+
| default |
| test |
+------------+
0: jdbc:hive2://kyuubicluster-sample-kyuubi:1> use test;
0: jdbc:hive2://kyuubicluster-sample-kyuubi:1> create table test3 (name string,id int);
0: jdbc:hive2://kyuubicluster-sample-kyuubi:1> insert into test3 values("kyuubi",1);
0: jdbc:hive2://kyuubicluster-sample-kyuubi:1> select * from test3;
+---------+-----+
| name | id |
+---------+-----+
| kyuubi | 1 |
+---------+-----+
```
## Contributing
Contributions are highly welcomed and appreciated.
### How it works
This project aims to follow the Kubernetes [Operator pattern](https://kubernetes.io/docs/concepts/extend-kubernetes/operator/).
It uses [Controllers](https://kubernetes.io/docs/concepts/architecture/controller/),
which provide a reconcile function responsible for synchronizing resources until the desired state is reached on the cluster.
### Test It Out
1. Install the CRDs into the cluster:
```sh
make install
```
2. Run your controller (this will run in the foreground, so switch to a new terminal if you want to leave it running):
```sh
make run
```
**NOTE:** You can also run this in one step by running: `make install run`
### Modifying the API definitions
If you are editing the API definitions, generate the manifests such as CRs or CRDs using:
```sh
make manifests
```
**NOTE:** Run `make --help` for more information on all potential `make` targets
More information can be found via the [Kubebuilder Documentation](https://book.kubebuilder.io/introduction.html)
## License
Copyright 2023 nineinfra.
Licensed 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.