@@ -10,29 +10,54 @@ sidebar_position: 1
1010
1111## Install on your Kubernetes cluster
1212
13- Deploy the OpenSergo control plane:
13+ Install ` OpenSergo Control Plane ` contains 2 steps:
14+ - Init OpenSergo in ` Kubernetes cluster `
15+ - Start the ` OpenSergo Control Plane `
1416
15- ``` shell
16- # Create opensergo-system namespace
17+ The above steps can be performed on the Kubernetes node or on the non-Kubernetes node.
18+ If you performance them on a non-Kubernetes node, you need to configure ` kubeconfig ` on the operating computer to access the Kubernetes cluster.
19+
20+
21+ ### Install by scripts online
22+
23+ We provide some scripts to install OpenSergo Control Plane:
24+
25+ ``` shell
26+ # NOTE:exec above command,will download the resources in directory `$HOME/opensergo/opensergo-control-plane`
27+
28+ # 1. Install base resources of OpenSergo (Namespce, CRD, RBAC ...)
29+ wget --no-check-certificate https://raw.githubusercontent.com/opensergo/opensergo-control-plane/main/cmd/init/init.sh && chmod +x init.sh && ./init.sh
30+
31+ # 2. Deploy workload of OpenSergo Control Plane
32+ wget --no-check-certificate https://raw.githubusercontent.com/opensergo/opensergo-control-plane/main/cmd/install/k8s/deploy.sh && chmod +x deploy.sh && ./deploy.sh
33+ ```
34+
35+
36+ ### Install by YAML
37+ In advance, we need to download [ ` opensergo-control-plane ` ] ( https://github.com/opensergo/opensergo.github.io ) , and then execute kubectl commands to install OpenSergo Control Plane.
38+ ``` shell
39+ # Create Namespace for OpenSergo
1740kubectl apply -f opensergo-control-plane/k8s/namespace.yaml
1841
19- # Install OpenSergo CRDs
42+ # Install OpenSergo spec CRDs
2043kubectl apply -f opensergo-control-plane/k8s/crd/bases/fault-tolerance.opensergo.io_circuitbreakerstrategies.yaml
2144kubectl apply -f opensergo-control-plane/k8s/crd/bases/fault-tolerance.opensergo.io_concurrencylimitstrategies.yaml
2245kubectl apply -f opensergo-control-plane/k8s/crd/bases/fault-tolerance.opensergo.io_faulttolerancerules.yaml
2346kubectl apply -f opensergo-control-plane/k8s/crd/bases/fault-tolerance.opensergo.io_ratelimitstrategies.yaml
2447kubectl apply -f opensergo-control-plane/k8s/crd/bases/fault-tolerance.opensergo.io_throttlingstrategies.yaml
2548kubectl apply -f opensergo-control-plane/k8s/crd/bases/traffic.opensergo.io_trafficerouters.yaml
2649
27- # Apply RBAC
50+ # Install RBAC for OpenSergo Control Plane
2851kubectl apply -f opensergo-control-plane/k8s/rbac/rbac.yaml
2952
30- # Install OpenSergo control plane workload
53+ # Deploy workload for OpenSergo Control Plane
3154kubectl apply -f opensergo-control-plane/k8s/workload/opensergo-control-plane.yaml
3255```
3356
34- > NOTE: the community is working on Helm chart of the control plane.
35-
36- ## Configuration
57+ ### Attentions
58+ - ` ClusterIP ` is the default mode of Service, you can change mode to ` NodePort ` or ` LoadBalancer ` to expose this Service
59+ - ** Start by script online** , file to modify: ` $HOME/opensergo/opensergo-control-plane/k8s/workload/opensergo-control-plane.yaml `
60+ - ** Start by YAML** , file to modify: ` opensergo-control-plane/k8s/workload/opensergo-control-plane.yaml `
61+ - default value of ` replicas ` in Deployment is 1, do not modify it. Multiple-replicas mode is still in developing.
3762
38- (TBD...)
63+ * We are improving start mode for OpenSergo control plane, and will provide Helm Chart deployment package in the future. *
0 commit comments