From 7eebc477848a1759fdbb63bd0a374857d5a56907 Mon Sep 17 00:00:00 2001 From: zhuxiaoyang Date: Thu, 19 Dec 2019 19:19:10 +0800 Subject: [PATCH] update s2i docs Signed-off-by: zhuxiaoyang --- docs/en/concepts-and-designs/README.md | 2 +- .../concepts-and-designs/s2i_b2i_overview.md | 22 +++++++++++++++++++ docs/en/guides/README.md | 4 +++- 3 files changed, 26 insertions(+), 2 deletions(-) create mode 100644 docs/en/concepts-and-designs/s2i_b2i_overview.md diff --git a/docs/en/concepts-and-designs/README.md b/docs/en/concepts-and-designs/README.md index d1f40885c..3813bc209 100644 --- a/docs/en/concepts-and-designs/README.md +++ b/docs/en/concepts-and-designs/README.md @@ -40,7 +40,7 @@ TODO(@runzexia) ### 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..d5f9d62be --- /dev/null +++ b/docs/en/concepts-and-designs/s2i_b2i_overview.md @@ -0,0 +1,22 @@ +# Kubesphere S2I/B2I overview + +Kubesphere S2I/B2I provides easy CI/CD functionality. + +It will installed in namespaces `kubesphere-devops-system` by enable devops component. + +In S2I, all resource 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 resource by call k8s api directly. + +There are two mudule 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 + +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) \ No newline at end of file diff --git a/docs/en/guides/README.md b/docs/en/guides/README.md index 356835a87..7dd5de2f9 100644 --- a/docs/en/guides/README.md +++ b/docs/en/guides/README.md @@ -60,7 +60,9 @@ TODO(@runzexia) ### KubeSphere S2I/B2I developer -TODO(@soulseen) +1. If users who are interested in S2I/B2I, please read the documentation of [S2I/B2I](https://github.com/kubesphere/s2ioperator#source-to-image-operator) to get start it. + +2. For developers who are want to contribute, read the documentation according to the [Development Guide for S2I/B2I](https://github.com/kubesphere/s2ioperator/blob/master/docs/DEVELOPMENT.md) ### KubeSphere Monitoring developer