v2.1

v2.0

v1.0

Release Notes

产品介绍

安装指南
1. 安装说明
1. 在 Linux 快速安装 KubeSphere
1. 在 Kubernetes 安装 KubeSphere
2. 1. 准备工作
  2. 在 Kubernetes 安装 KubeSphere
1. 集群高可用配置安装
1. 相关工具与插件
1. 认证配置
2. 1. 接入 LDAP / AD 域账号（Beta）
1. 集群运维

升级指南

快速入门

用户指南
1. 应用
1. 存储
1. 网络与服务
1. 监控告警
2. 1. 告警策略 - 工作负载级别
  2. 告警消息 - 工作负载级别
1. 配置中心
1. 项目设置

开发者指南
1. Helm 应用开发
2. 1. 开发模板规范
  2. Helm 应用开发入门
1. Source to Image(S2I) 自定义模版开发
2. 1. S2I 原理及流程介绍
  2. 自定义 S2I 模版

API 文档

常见问题

附录

文档中心

简体中文 English

开发自定义 S2I 模版

编辑

对 Source-to-image (S2I) 工作原理有了一定了解之后，您也可以为自己的项目定义自己的构建器镜像模版 (即 S2I/B2I 模板) 来扩展 S2I，在我们的项目当中提供了部分常用的构建器镜像模版，例如 Python、Java 等。在 Kubesphere 2.1.1 版本中已经支持自定义 B2I 模版。

在详细介绍构建器镜像之前，先介绍下完成构建器镜像模版所需要提供的元素。

在自定 S2I 模版时，主要分为两个部分：第一部分为 S2I 的构建器镜像。第二部分为 S2Itemplate 的定义。

其中构建器镜像与 Openshift 的构建器镜像兼容，在 KubeSphere 中可以复用此部分。

1.1.assemble - 负责构建应用程序的脚本
1.2.run - 负责运行应用程序的脚本
1.3.save-artifacts - 在增量构建时负责依赖管理的脚本（可选)
1.4.usage - 使用说明脚本（可选）
1.5.test - 一些测试脚本（可选)
2.1.S2Itemplate - 描述构建程序所使用的基础环境

S2I 构建器镜像的更多的信息可参考 S2IRun

在以下的步骤中，我们将向您展示如何创建一个 Nginx 服务的构建器镜像。若项目中希望使用运行时镜像(Runtime Image)，可以参考文档如何构建运行时镜像

第一步：S2i CLI 构建项目目录

S2I 命令行工具带有一个方便的命令，可以引导构建器所需的目录结构。如下安装 S2I CLI：

$ wget https://github.com/openshift/source-to-image/releases/download/v1.1.14/source-to-image-v1.1.14-874754de-linux-386.tar.gz

$ tar -xvf source-to-image-v1.1.14-874754de-linux-386.tar.gz

$ ls
s2i  source-to-image-v1.1.14-874754de-linux-386.tar.gz  sti

$ cp s2i /usr/local/bin

$ s2i create nginx-centos7 s2i-builder-docs

本文使用 nginx-centos7 作为构建器镜像的名字创建了初始目录，目录结构如下所示。

s2i-builder-docs/
   Dockerfile - 一个标准的Dockerfile，定义了构建器镜像。
   Makefile - 用于测试和构建构建器镜像的帮助脚本。
   test/
      run - 测试脚本，测试构建器镜像是否正常工作。
      test-app/ - 用于测试的应用程序的目录
   s2i/bin
      assemble - 负责构建应用程序的脚本
      run - 负责运行应用程序的脚本
      usage - 负责打印构建器镜像用法的脚本

第二步：修改 Dockerfile

如下修改 Dockerfile 来定义构建器镜像。

Dockerfile

# nginx-centos7
FROM kubespheredev/s2i-base-centos7:1


LABEL maintainer="Runze Xia <runzexia@yunify.com>"

# 声明当前应用的版本
ENV NGINX_VERSION=1.6.3


LABEL io.k8s.description="Nginx Webserver" \
      io.k8s.display-name="Nginx 1.6.3" \
      io.kubesphere.expose-services="8080:http" \
      io.kubesphere.tags="builder,nginx,html"

# 安装nginx并且清理yum cache
RUN yum install -y epel-release && \
    yum install -y --setopt=tsflags=nodocs nginx && \
    yum clean all

# 修改nginx的默认开放端口
RUN sed -i 's/80/8080/' /etc/nginx/nginx.conf
RUN sed -i 's/user nginx;//' /etc/nginx/nginx.conf

# 将S2I的脚本复制到构建器镜像当中
COPY ./s2i/bin/ /usr/libexec/s2i

RUN chown -R 1001:1001 /usr/share/nginx
RUN chown -R 1001:1001 /var/log/nginx
RUN chown -R 1001:1001 /var/lib/nginx
RUN touch /run/nginx.pid
RUN chown -R 1001:1001 /run/nginx.pid
RUN chown -R 1001:1001 /etc/nginx

USER 1001

# 声明默认使用的端口
EXPOSE 8080

# 修改构建器的默认启动命令，以展示构建器镜像的用法
CMD ["/usr/libexec/s2i/usage"]

S2I 脚本中会根据 Dockerfile 中定义的 Label 信息作为使用参数，如果使用非 KubeSphere 提供的基础镜像，请参考 S2I Script

第三步处理S2I构建器脚本

当我们完成了 Dockerfile 的定义，我们现在可以完成构建器镜像的其他部分。我们现在添加S2I脚本，我们将从 assemble（负责构建应用程序）开始。如下编辑 assemble 文件，在我们的例子中，它只是把 nginx 的配置文件以及静态内容复制到目标容器中：

assemble

#!/bin/bash -e

if [[ "$1" == "-h" ]]; then
	exec /usr/libexec/s2i/usage
fi

echo "---> Building and installing application from source..."
if [ -f /tmp/src/nginx.conf ]; then
  mv /tmp/src/nginx.conf /etc/nginx/nginx.conf
fi

if [ "$(ls -A /tmp/src)" ]; then
  mv /tmp/src/* /usr/share/nginx/html/
fi

默认情况下，s2i build 将应用程序源代码放在 /tmp/src 目录中，在上面的命令当中，我们将应用源代码复制到了了 kubespheredev/s2i-base-centos7:1 定义的工作目录 /opt/app-root/src 当中。

现在我们可以来处理第二个脚本 run (用于启动应用程序)，在我们的例子当中，它只是启动 nginx 服务器：

run

#!/bin/bash -e

exec /usr/sbin/nginx -g "daemon off;"

我们使用 exec 命令将执行 run 脚本替换为执行 nginx 服务器的主进程。我们这样做是为了让所有 docker 发出的信号都可以被 nginx 收到，并且可以让 nginx 使用容器的标准输入和标准输出流。

我们在例子当中被没有实现增量构建，因此我们可以直接删除 save-artifacts 脚本。

最后我们在 usage 脚本当中添加一些使用信息：

usage

#!/bin/bash -e
cat <<EOF
This is the nginx-centos7 S2I image:
To use it, install S2I: https://github.com/kubesphere/s2i-operator
Sample invocation:
s2i build test/test-app kubespheredev/nginx-centos7 nginx-centos7-app
You can then run the resulting image via:
docker run -d -p 8080:8080 nginx-centos7-app
and see the test via http://localhost:8080
EOF

第四步构建与运行

当我们完成了 Dockerfile 和 S2I 的脚本，我们现在修改一下 Makefile 当中的镜像名称:

Makefile

IMAGE_NAME = kubespheredev/nginx-centos7-s2ibuilder-sample

.PHONY: build
build:
	docker build -t $(IMAGE_NAME) .

.PHONY: test
test:
	docker build -t $(IMAGE_NAME)-candidate .
	IMAGE_NAME=$(IMAGE_NAME)-candidate test/run

可以执行 make build 命令来构建我们的构建器镜像了。

$ make build
docker build -t kubespheredev/nginx-centos7-s2ibuilder-sample .
Sending build context to Docker daemon  164.9kB
Step 1/17 : FROM kubespheredev/s2i-base-centos7:1
 ---> 48f8574c05df
Step 2/17 : LABEL maintainer="Runze Xia <runzexia@yunify.com>"
 ---> Using cache
 ---> d60ebf231518
Step 3/17 : ENV NGINX_VERSION=1.6.3
 ---> Using cache
 ---> 5bd34674d1eb
Step 4/17 : LABEL io.k8s.description="Nginx Webserver"       io.k8s.display-name="Nginx 1.6.3"       io.kubesphere.expose-services="8080:http"       io.kubesphere.tags="builder,nginx,html"
 ---> Using cache
 ---> c837ad649086
Step 5/17 : RUN yum install -y epel-release &&     yum install -y --setopt=tsflags=nodocs nginx &&     yum clean all
 ---> Running in d2c8fe644415

…………
…………
…………

Step 17/17 : CMD ["/usr/libexec/s2i/usage"]
 ---> Running in c24819f6be27
Removing intermediate container c24819f6be27
 ---> c147c86f2cb8
Successfully built c147c86f2cb8
Successfully tagged kubespheredev/nginx-centos7-s2ibuilder-sample:latest

可以看到我们的镜像已经构建成功了，现在我们执行 s2i build ./test/test-app kubespheredev/nginx-centos7-s2ibuilder-sample:latest sample app 命令来构建我们的应用镜像。

$ s2i build ./test/test-app kubespheredev/nginx-centos7-s2ibuilder-sample:latest sample-app
---> Building and installing application from source...
Build completed successfully

当我们完成了应用镜像的构建，我们可以在本地运行这个应用镜像看构建出的应用是否符合我们的要求：

$ docker run -p 8080:8080  sample-app

在浏览器中访问，可以看到我们的网页已经可以正常访问了:

第五步推送镜像并在 KubeSphere 添加 S2I 模版

S2I 模版定义了应用程序构建的基础环境，包括构建器镜像 (Builder Image) 和运行时镜像 (Runtime Image)，以及环境参数、描述信息等。

当我们在本地完成 S2I 构建器镜像的测试之后，就可以推送镜像到自定义的镜像仓库当中，并创建构建器模版 yaml 文件：

s2ibuildertemplate.yaml

apiVersion: devops.kubesphere.io/v1alpha1
kind: S2iBuilderTemplate
metadata:
  labels:
    controller-tools.k8s.io: "1.0"
    builder-type.kubesphere.io/s2i: "s2i"
  name: nginx-demo
spec:
  containerInfo:
    - builderImage: kubespheredev/nginx-centos7-s2ibuilder-sample
  codeFramework: nginx # 代码框架类型
  defaultBaseImage: kubespheredev/nginx-centos7-s2ibuilder-sample # 默认使用的构建器镜像 (可替换为自定义的镜像)
  version: 0.0.1 # 构建器模版的版本
  description: "This is a S2I builder template for Nginx builds whose result can be run directly without any further application server.." # 构建器模版的描述信息

提示：S2I 模版中 label 作为前端分类的参数信息，详见本文底部的 S2I 参数释义表。

在创建好构建器模版后我们可以使用 kubectl 将构建器模版提交到 KubeSphere 环境当中：

$ kubectl apply -f s2ibuildertemplate.yaml
s2ibuildertemplate.devops.kubesphere.io/nginx created

现在我们来到 KubeSphere 的控制台界面，我们已经可以选择添加的构建器模版了：

至此我们就完成了 S2I 构建器镜像与构建器模版的创建。类似地，可以参考上述步骤，您可以基于 S2I CLI 自定义任何所需的 S2I 模板，然后在 KubeSphere 构建所需的镜像并一键部署至 Kubernetes 环境中，方便快速与多次构建环境。

S2I 模板参数释义表

S2I 模版中 label 作为前端分类的参数信息，其详细描述如下表所示。

label名称	选项	含义
builder-type.kubesphere.io/s2i: "s2i"	"s2i"	描述该模版类型属于 S2I，即基于应用源代码进行构建
builder-type.kubesphere.io/b2i	"b2i"	描述该模版类型属于 B2I, 即基于二进制或其他制品进行构建
binary-type.kubesphere.io	"jar","war","binary"	描述该模版类型属于 B2I 下的细分类型，当选择 "B2I" 类型是需要加上此 label。比如提供的 jar 包则可以选择 "jar" 类型，其他类似。在 v2.1.1 版本中支持自定义 B2I 模版，例如 "nginx" 等

S2I 模版详细参数信息如下表所示，其中带有 * 的参数表示必填项：

修改项	类型	含义
*containerInfo	[]struct	构建镜像的相关信息列表
*containerInfo.builderImage	string	S2I 构建器镜像，比如：kubesphere/java-8-centos7:v2.1.0
containerInfo.runtimeImage	string	S2I 运行时镜像镜像，比如：kubesphere/java-8-runtime:v2.1.0
containerInfo.buildVolumes	[]string	挂载卷信息列表，格式"volume_name:mount_path"，比如：["s2i_java_cache:/tmp/artifacts","test_cache:test_path"]
containerInfo.runtimeArtifacts	[]struct	输出制品的原路径和目标路径列表，仅用于分阶段构建时使用
containerInfo.runtimeArtifacts.source	string	制品在构建器镜像中的原路径
containerInfo.runtimeArtifacts.destination	string	移动到运行时镜像中的目标路径
containerInfo.runtimeArtifacts.keep	bool	是否将数据保留在最终镜像中
*defaultBaseImage	string	默认使用的构建器镜像
*codeFramework	string	代码框架类型，比如 Java、Ruby 等
environment	[]struct	列表，用于设置一系列构建过程中的环境变量
environment.key	string	环境变量名称
environment.type	string	环境变量值类型
environment.description	string	环境变量描述信息
environment.optValues	[]string	环境变量参数列表
environment.required	bool	是否必须设置该环境变量
environment.defaultValue	string	环境变量默认值
environment.value	string	环境变量值
iconPath	string	应用名称
version	string	S2I 模版版本
description	string	用于描述此模版的功能、用途等

KubeSphere Docs

Release Notes

Release Notes - 2.1.1最新

Release Notes - 2.1.0

Release Notes - 2.0.2

Release Notes - 2.0.1

Release Notes - 2.0.0

产品介绍

什么是 KubeSphere

平台功能

为什么选择 KubeSphere

架构说明

应用场景

名词解释

安装指南

安装说明

概览

网络防火墙配置

集群其它参数配置

在 Linux 快速安装 KubeSphere

All-in-One 模式

Multi-Node 模式

完整安装（开启所有功能组件）

在 Kubernetes 安装 KubeSphere

准备工作

在 Kubernetes 安装 KubeSphere

安装可插拔的功能组件

可插拔功能组件概览

安装应用商店

安装内置的 DevOps 系统

安装内置的日志系统

安装微服务治理组件（Service Mesh）

安装告警通知系统

安装 Metrics-server 开启 HPA

验证可插拔功能组件的安装

集群高可用配置安装

在青云安装 HA 集群

在华为云安装 HA 集群

持久化存储配置说明

相关工具与插件

安装内置 Grafana

访问 SonarQube 和 Jenkins 服务端

安装 Porter 负载均衡器插件

安装 QingCloud 负载均衡器插件

认证配置

接入 LDAP / AD 域账号（Beta）

集群运维

安装后添加新的存储类型

集群节点扩容

卸载

升级指南

升级必读

All-in-One 升级

Multi-node 升级

快速入门

入门必读

1. 多租户管理快速入门

2. 应用路由与服务示例

3. 创建 Wordpress 应用并发布至 K8s

4. 一键部署应用

5. 创建简单任务

6. 设置弹性伸缩 (HPA)

7. Source-to-Image

8. Binary-to-Image

9. 基于Spring Boot项目构建流水线

10. 图形化构建流水线

11. Bookinfo 微服务的灰度发布

12. 使用 Ingress-Nginx 进行灰度发布

13. 应用商店

管理员指南

多租户管理

多租户管理概述

角色权限概览

平台管理

企业空间管理

账号管理

平台角色

基础设施

服务组件

主机管理

存储类型