Skip to content

Commit

Permalink
Merge pull request #519 from cloud-ark/custom-resource-connections
Browse files Browse the repository at this point in the history
README and details page update
  • Loading branch information
devdattakulkarni authored Jun 10, 2020
2 parents 4a3a794 + 5ed56e2 commit 75f0182
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ resource/label-relationship
resource/specproperty-relationship
```

More details on how to use these annotations can be found [here](./details.rst))
More details on how to use these annotations can be found [here](./details.rst)

### Client-side kubectl plugins

Expand Down Expand Up @@ -123,7 +123,7 @@ Total MEMORY(bytes): 302Mi
- KubePlus kubectl commands:
- ```$ export KUBEPLUS_HOME=<Full path where kubeplus is cloned>```
- ```$ export PATH=$KUBEPLUS_HOME/plugins/:$PATH```
- KubePlus Cluster-side component:
- KubePlus Cluster-side add-on:
- ```$ ./scripts/deploy-kubeplus.sh```
- Check out [examples](./examples/moodle-with-presslabs/).

Expand Down
15 changes: 9 additions & 6 deletions details.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ Details
Kubernetes Custom Resources and Custom Controllers, popularly known as `Operators`_, extend Kubernetes to run third-party softwares directly on Kubernetes. Teams adopting Kubernetes assemble required Operators of platform softwares such as databases, security, backup etc. to build the required application platforms. KubePlus tooling simplifies creation of Kubernertes-native platform workflows leveraging these Custom Resources.

.. image:: ./docs/Kubernetes-native-stack-with-KubePlus.jpg
:scale: 15%
:height: 300px
:width: 300px
:align: center

The main benefit of using KubePlus to DevOps engineers/application developers are:
Expand All @@ -43,11 +44,11 @@ KubePlus API Add-on provides discovery commands, binding functions, and an orche
KubePlus Components
-------------------------------
KubePlus tooling is made up of - Platform-as-Code Annotations, client-side kubectl plugins, and server-side components (binding functions and PlatformWorkflow CRD).
KubePlus tooling is made up of - CRD Annotations, client-side kubectl plugins, and server-side components (binding functions and PlatformWorkflow CRD).


Platform-as-Code Resource annotations
--------------------------------------
Resource annotations
----------------------

In order to build and maintain Custom Resource relationship graph, KubePlus expects CRD packages to be updated with annotations as described below.

Expand Down Expand Up @@ -210,7 +211,7 @@ Check our `slide deck`_ in the Kubernetes Community Meeting for more details of

PlatformWorkflow Operator
--------------------------
Creating workflows requires treating the set of resources representing the workflow as a unit. For this purpose, KubePlus provides a Custom Resource of its own - PlatformWorkflow. This Custom Resource enables application developers to define all the resources in a workflow as a unit along with the inter-dependencies between them. The dependency information is used for ensuring robustness and security of the workflows including, preventing out-of-order creation of resources and ensuring that resources that are still in use cannot be deleted. This CRD is being updated to enable applying certain workflow level security or robustness guarantees to all resources involved.
Creating workflows requires treating the set of resources representing the workflow as a unit. For this purpose, KubePlus provides a Custom Resource of its own - PlatformWorkflow. This Custom Resource enables application developers to define all the resources in a workflow as a unit along with the inter-dependencies between them. The dependency information is used for ensuring robustness and security of the workflows including, preventing out-of-order creation of resources and ensuring that resources that are still in use cannot be deleted.

PlatformWorkflow Operator does not actually deploy any resources defined in a workflow. Resource creation is done by application developers as usual using 'kubectl'.

Expand Down Expand Up @@ -283,7 +284,9 @@ KubePlus in Action
Operator FAQ
-------------

New to Operators? Checkout [Operator FAQ](https://github.com/cloud-ark/kubeplus/blob/master/Operator-FAQ.md).
New to Operators? Checkout `Operator FAQ`_

.. _Operator FAQ: https://github.com/cloud-ark/kubeplus/blob/master/Operator-FAQ.md.



Expand Down

0 comments on commit 75f0182

Please sign in to comment.