diff --git a/docs/en/concepts-and-designs/README.md b/docs/en/concepts-and-designs/README.md index 197500565..d45e2919a 100644 --- a/docs/en/concepts-and-designs/README.md +++ b/docs/en/concepts-and-designs/README.md @@ -40,7 +40,7 @@ Read [DevOps Pipeline Overview](devops-pipeline-overview.md). ### KubeSphere S2I/B2I -TODO(@soulseen) +Read [S2I/B2I Overview](s2i_b2i_overview.md) ### KubeSphere Monitoring diff --git a/docs/en/concepts-and-designs/s2i_b2i_overview.md b/docs/en/concepts-and-designs/s2i_b2i_overview.md new file mode 100644 index 000000000..e83064b2a --- /dev/null +++ b/docs/en/concepts-and-designs/s2i_b2i_overview.md @@ -0,0 +1,34 @@ +# KubeSphere S2I/B2I overview + +## What is S2I/B2I + +Kubesphere S2I(Source-to-Image) / B2I(Binary-to-Image) provides easy CI/CD functionalities, help developers to publish their service to Kubernetes without writing Dockefile. + +## Workflow Example + +![](https://pek3b.qingstor.com/kubesphere-docs/png/20191223103533.png) + +## Principle + +All resources of S2I/B2I will be installed in namespace `kubesphere-devops-system` by enable devops component. + +In S2I, all resources and CI/CD steps are defined with [Custom Resource Defintion](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/) (CRD). You can operate all s2i resources by call k8s api directly. + +There are two mudules included in the S2I component: + +1. S2I Operator: A Kubernetes CRD controller that provides easy Kubernetes-style resources for declaring CI/CD-style pipelines +2. S2IRun: It is the instance that executes the s2i build process in containers. + +Besides, the S2I stack includes following CRD resources: + +1. s2ibuildertemplates: defines information about S2I builder image. +2. s2ibuilders: all configuration information used in building are stored in this CRD. +3. s2iruns: defines an action about build + +Here is a graph that describes the relationship about all CRD within S2I architecture: + +​![](../../images/s2i_arch.png) + +Also you can install S2I component in any kubernetes cluster without KubeSphere. + +Want to see more about s2i, please jump to [S2I Operator](https://github.com/kubesphere/s2ioperator) and [S2IRun](https://github.com/kubesphere/s2irun) diff --git a/docs/en/guides/README.md b/docs/en/guides/README.md index d07885d0d..54f8cf70d 100644 --- a/docs/en/guides/README.md +++ b/docs/en/guides/README.md @@ -65,7 +65,9 @@ The function of KubeSphere DevOps is mainly provided by KubeSphere apiserver. ### KubeSphere S2I/B2I developer -TODO(@soulseen) +1. If users who are interested in S2I/B2I, please read [S2I/B2I](https://github.com/kubesphere/s2ioperator#source-to-image-operator) to get start it. + +2. For developers who want to contribute, see [Development Guide for S2I/B2I](https://github.com/kubesphere/s2ioperator/blob/master/docs/DEVELOPMENT.md) ### KubeSphere Monitoring developer diff --git a/docs/images/s2i_arch.png b/docs/images/s2i_arch.png new file mode 100644 index 000000000..6e7a43a37 Binary files /dev/null and b/docs/images/s2i_arch.png differ