-
Notifications
You must be signed in to change notification settings - Fork 82
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update README.md to include a "Quick Installation" section and move t…
…he getting-started example to a separate file to streamline the README
- Loading branch information
1 parent
17fc4d8
commit 72bdcd6
Showing
2 changed files
with
167 additions
and
124 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,135 @@ | ||
| # Kubeplus | ||
|
|
||
| ## Getting Started with an example | ||
|
|
||
| Let’s look at an example of creating a multi-instance WordPress Service using KubePlus. The WordPress service provider goes through the following steps towards this on their cluster: | ||
|
|
||
| 1. Create cluster or use an existing cluster. For testing purposes you can create a [minikube](https://minikube.sigs.k8s.io/docs/) or [kind](https://kind.sigs.k8s.io/) cluster: | ||
|
|
||
| `minikube start` | ||
|
|
||
| or | ||
|
|
||
| `kind create cluster` | ||
|
|
||
| 2. Set the Namespace in which to deploy KubePlus | ||
|
|
||
| `export KUBEPLUS_NS=default` | ||
|
|
||
| 3. Create provider kubeconfig using provider-kubeconfig.py | ||
|
|
||
| ```sh | ||
| wget https://raw.githubusercontent.com/cloud-ark/kubeplus/master/requirements.txt | ||
| wget https://raw.githubusercontent.com/cloud-ark/kubeplus/master/provider-kubeconfig.py | ||
| python3 -m venv venv | ||
| source venv/bin/activate | ||
| pip3 install -r requirements.txt | ||
| apiserver=`kubectl config view --minify -o jsonpath='{.clusters[0].cluster.server}'` | ||
| python3 provider-kubeconfig.py -s $apiserver create $KUBEPLUS_NS | ||
| deactivate | ||
| ``` | ||
|
|
||
| 4. Install KubePlus Operator, KubePlus kubectl plugin using the `install.sh` script | ||
|
|
||
| ```sh | ||
| ./install.sh --kubeplus --kubeplus-plugin | ||
| ``` | ||
|
|
||
| 5. Create Kubernetes CRD representing WordPress Helm chart. | ||
|
|
||
| *The WordPress Helm chart can be specified as a [public url](./examples/multitenancy/application-hosting/wordpress/wordpress-service-composition.yaml) or can be [available locally](./examples/multitenancy/application-hosting/wordpress/wordpress-service-composition-localchart.yaml).* | ||
|
|
||
| ```sh | ||
| kubectl create -f https://raw.githubusercontent.com/cloud-ark/kubeplus/master/examples/multitenancy/application-hosting/wordpress/wordpress-service-composition.yaml --kubeconfig=kubeplus-saas-provider.json | ||
| kubectl get resourcecompositions | ||
| kubectl describe resourcecomposition wordpress-service-composition | ||
| ``` | ||
|
|
||
| If the status of the `wordpress-service-composition` indicates that the new CRD has been created successfully, verify it: | ||
|
|
||
| ```sh | ||
| kubectl get crds | ||
| ``` | ||
|
|
||
| You should see `wordpressservices.platformapi.kubeplus` CRD registered. | ||
|
|
||
| 6. Create WordpressService instance `wp-tenant1` | ||
|
|
||
| ```sh | ||
| kubectl create -f https://raw.githubusercontent.com/cloud-ark/kubeplus/master/examples/multitenancy/application-hosting/wordpress/tenant1.yaml --kubeconfig=kubeplus-saas-provider.json | ||
| ``` | ||
|
|
||
| 7. Create WordpressService instance `wp-tenant2` | ||
|
|
||
| ```sh | ||
| kubectl create -f https://raw.githubusercontent.com/cloud-ark/kubeplus/master/examples/multitenancy/application-hosting/wordpress/tenant2.yaml --kubeconfig=kubeplus-saas-provider.json | ||
| ``` | ||
|
|
||
| 8. Check created WordpressService instances | ||
|
|
||
| ```sh | ||
| kubectl get wordpressservices | ||
|
|
||
| NAME AGE | ||
| wp-tenant1 86s | ||
| wp-tenant2 26s | ||
| ``` | ||
|
|
||
| 9. Check the details of created instance | ||
|
|
||
| ```sh | ||
| kubectl describe wordpressservices wp-tenant1 | ||
| ``` | ||
|
|
||
| 10. Check created application resources | ||
|
|
||
| * Notice that the `WordpressService` instance resources are deployed in a Namespace `wp-tenant1`, which was created by KubePlus. | ||
|
|
||
| ```sh | ||
| kubectl appresources WordpressService wp-tenant1 –k kubeplus-saas-provider.json | ||
|
|
||
| NAMESPACE KIND NAME | ||
| default WordpressService wp-tenant1 | ||
| wp-tenant1 PersistentVolumeClaim mysql-pv-claim | ||
| wp-tenant1 PersistentVolumeClaim wp-for-tenant1 | ||
| wp-tenant1 Service wordpress-mysql | ||
| wp-tenant1 Service wp-for-tenant1 | ||
| wp-tenant1 Deployment mysql | ||
| wp-tenant1 Deployment wp-for-tenant1 | ||
| wp-tenant1 Pod mysql-76d6d9bdfd-2wl2p | ||
| wp-tenant1 Pod wp-for-tenant1-87c4c954-s2cct | ||
| wp-tenant1 NetworkPolicy allow-external-traffic | ||
| wp-tenant1 NetworkPolicy restrict-cross-ns-traffic | ||
| wp-tenant1 ResourceQuota wordpressservice-wp-tenant1 | ||
| ``` | ||
|
|
||
| 11. Check application resource consumption | ||
|
|
||
| ```sh | ||
| kubectl metrics WordpressService wp-tenant1 $KUBEPLUS_NS -k kubeplus-saas-provider.json | ||
|
|
||
| ---------------------------------------------------------- | ||
| Kubernetes Resources created: | ||
| Number of Sub-resources: - | ||
| Number of Pods: 2 | ||
| Number of Containers: 2 | ||
| Number of Nodes: 1 | ||
| Number of Not Running Pods: 0 | ||
| Underlying Physical Resoures consumed: | ||
| Total CPU(cores): 0.773497m | ||
| Total MEMORY(bytes): 516.30859375Mi | ||
| Total Storage(bytes): 40Gi | ||
| Total Network bytes received: 0 | ||
| Total Network bytes transferred: 0 | ||
| ---------------------------------------------------------- | ||
| ``` | ||
|
|
||
| 12. Cleanup | ||
|
|
||
| ```sh | ||
| kubectl delete wordpressservice wp-tenant1 --kubeconfig=kubeplus-saas-provider.json | ||
| kubectl delete wordpressservice wp-tenant2 --kubeconfig=kubeplus-saas-provider.json | ||
| kubectl delete resourcecomposition wordpress-service-composition --kubeconfig=kubeplus-saas-provider.json | ||
| helm delete kubeplus -n $KUBEPLUS_NS | ||
| python3 provider-kubeconfig.py delete $KUBEPLUS_NS | ||
| ``` |