You are viewing documentation for KubeSphere version:v3.0.0

KubeSphere v3.0.0 documentation is no longer actively maintained. The version you are currently viewing is a static snapshot. For up-to-date documentation, see the latest version.

Last updated:

Edit

Feedback

Binary to Image: Publish an Artifact to Kubernetes

Binary-to-Image (B2I) is a toolkit and workflow for building reproducible container images from binary executables such as Jar, War, and binary packages. More specifically, you upload an artifact and specify a target repository such as Docker Hub or Harbor where you want to push the image. If everything runs successfully, your image will be pushed to the target repository and your application will be automatically deployed to Kubernetes if you create a Service in the workflow.

In a B2I workflow, you do not need to write any Dockerfile. This not only reduces learning costs but improves release efficiency, which allows users to focus more on business.

This tutorial demonstrates two different ways to build an image based on an artifact in a B2I workflow. Ultimately, the image will be released to Docker Hub.

For demonstration and testing purposes, here are some example artifacts you can use to implement the B2I workflow:

Artifact Package	GitHub Repository
b2i-war-java8.war	spring-mvc-showcase
b2i-war-java11.war	springmvc5
b2i-binary	devops-go-sample
b2i-jar-java11.jar	java-maven-example
b2i-jar-java8.jar	devops-java-sample

Prerequisites

You have enabled the KubeSphere DevOps System.
You need to create a Docker Hub account. GitLab and Harbor are also supported.
You need to create a workspace, a project and an account (project-regular). The account must be invited to the project with the role of operator. For more information, see Create Workspaces, Projects, Accounts and Roles.
Set a CI dedicated node for building images. This is not mandatory but recommended for the development and production environment as it caches dependencies and reduces build time. For more information, see Set a CI Node for Dependency Caching.

Create a Service Using Binary-to-Image (B2I)

The steps below show how to upload an artifact, build an image and release it to Kubernetes by creating a Service in a B2I workflow.

service-build

Step 1: Create a Docker Hub Secret

You must create a Docker Hub Secret so that the Docker image created through B2I can be push to Docker Hub. Log in to KubeSphere as project-regular, go to your project and create a Secret for Docker Hub. For more information, see Create the Most Common Secrets.

Step 2: Create a Service

In the same project, navigate to Services under Application Workloads and click Create.
Scroll down to Build a New Service through the Artifact and select war. This tutorial use the spring-mvc-showcase project as a sample and uploads a war artifact to KubeSphere. Set a name, such as b2i-war-java8, and click Next.
On the Build Settings page, provide the following information accordingly and click Next.

Service Type: Select Stateless Service for this example. For more information about different Services, see Service Type.

Upload Artifact: Upload the war artifact (b2i-war-java8).

Build Environment: Select kubesphere/tomcat85-java8-centos7:v2.1.0.

imageName: Enter <DOCKERHUB_USERNAME>/<IMAGE NAME> or <HARBOR-PROJECT_NAME>/<IMAGE NAME> as the image name.

tag: The image tag. Enter latest.

Target image repository: Select the Docker Hub Secret as the image is pushed to Docker Hub.
On the Container Settings page, scroll down to Service Settings to set the access policy for the container. Select HTTP for Protocol, customize the name (for example, http-port), and input 8080 for both Container Port and Service Port. Click Next to continue.

Note

For more information about how to set other parameters on the Container Settings page, see Container Image Settings.
On the Mount Volumes page, you can add a volume for the container. For more information, see Volumes. Click Next to continue.
On the Advanced Settings page, check Internet Access and select NodePort as the access method. Click Create to finish the whole process.
Click Image Builder from the navigation bar and you can see that the example image is being built.

Step 3: Check results

Wait for a while and you can see the status of the image has reached Successful.
Click this image to go to its detail page. Under Job Records, click the arrow icon on the right of a record to see building logs. You can see Build completed successfully at the end of the log if everything runs normally.
Go back to the previous page, and you can see the corresponding Job, Deployment and Service of the image have all been created successfully.

Service

Deployment

Job
In your Docker Hub repository, you can see that KubeSphere has pushed the image to the repository with the expected tag.

Step 4: Access the B2I Service

On the Services page, click the B2I Service to go to its detail page, where you can see the port number has been exposed.
Access the Service at http://{$Node IP}:{$NodePort}/{$Binary-Package-Name}/.

Note

You may need to open the port in your security groups and configure port forwarding rules depending on your deployment environment.

Use the Image Builder to build an image

The example above implements the entire workflow of B2I by creating a Service. Alternatively, you can use the Image Builder directly to build an image based on an artifact while this method will not publish the image to Kubernetes.

build-binary

Note

Make sure you have created a Secret for Docker Hub. For more information, see Create the Most Common Secrets.

Step 1: Upload an artifact

Log in to KubeSphere as project-regular and go to your project.
Select Image Builder from the navigation bar and click Create.
In the dialog that appears, select binary and click Next.
On the Build Settings page, provide the following information accordingly and click Create.

Upload Artifact: Download b2i-binary and upload it to KubeSphere.

Build Environment: Select kubesphere/s2i-binary:v2.1.0.

imageName: Customize an image name.

tag: The image tag. Enter latest.

Target image repository: Select the Docker Hub Secret as the image is pushed to Docker Hub.
On the Image Builder page, you can see that the image is being built.

Step 2: Check results

Wait for a while and you can see the status of the image has reached Successful.
Click this image to go to its detail page. Under Job Records, click the arrow icon on the right of a record to see building logs. You can see Build completed successfully at the end of the log if everything runs normally.
Go back to the previous page, and you can see the corresponding Job of the image has been created successfully.
In your Docker Hub repository, you can see that KubeSphere has pushed the image to the repository with the expected tag.