🚀 KubeSphere 3.1.1 is now available as it extends Kubernetes from the cloud to the edge. Read the introduction for 3.1.x → close
  • English
    • English
    • 简体中文
    1. 1.Experience account: demo1 / Demo123
    2. 2.This account is only allowed to view parts of UI
    3. 3.It's recommended that install KubeSphere in your environment
  •  Star
  1. Documentation / 
  2. Project User Guide / 
  3. Application Workloads / 
  4. Deployments

Project User Guide

Last updated:
    Edit

    Deployments

    A Deployment controller provides declarative updates for Pods and ReplicaSets. You describe a desired state in a Deployment object, and the Deployment controller changes the actual state to the desired state at a controlled rate. As a Deployment runs a number of replicas of your application, it automatically replaces instances that go down or malfunction. This is how Deployments make sure app instances are available to handle user requests.

    For more information, see the official documentation of Kubernetes.

    Prerequisites

    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.

    Create a Deployment

    Step 1: Open the dashboard

    Log in to the console as project-regular. Go to Application Workloads of a project, select Workloads, and click Create under the tab Deployments.

    deployments

    Step 2: Enter basic information

    Specify a name for the Deployment (for example, demo-deployment) and click Next to continue.

    deployments

    Step 3: Set an image

    1. Before you set an image, define the number of replicated Pods in Pod Replicas by clicking or , which is indicated by the .spec.replicas field in the manifest file.

      Tip

      You can see the Deployment manifest file in YAML format by enabling Edit Mode in the upper-right corner. KubeSphere allows you to edit the manifest file directly to create a Deployment. Alternatively, you can follow the steps below to create a Deployment via the dashboard.

      deployments

    2. Click Add Container Image.

      deployments

    3. Enter an image name from public Docker Hub or from a private repository you specified. For example, enter nginx in the search bar and press Enter.

      deployments

      Note

      • Remember to press Enter on your keyboard after you enter an image name in the search bar.
      • If you want to use your private image repository, you should create an Image Registry Secret first in Secrets under Configurations.

    4. Set requests and limits for CPU and memory resources based on your needs. For more information, see Resource Request and Resource Limit in Container Image Settings.

      deployments

    5. Click Use Default Ports for Port Settings or you can customize Protocol, Name and Container Port.

    6. Select a policy for image pulling from the drop-down menu. For more information, see Image Pull Policy in Container Image Settings.

    7. For other settings (Health Checker, Start Command, Environment Variables, Container Security Context and Sync Host Timezone), you can configure them on the dashboard as well. For more information, see detailed explanations of these properties in Container Image Settings. When you finish, click √ in the lower-right corner to continue.

    8. Select an update strategy from the drop-down menu. It is recommended that you choose RollingUpdate. For more information, see Update Strategy.

    9. Select a deployment mode. For more information, see Deployment Mode.

    10. Click Next to continue when you finish setting the container image.

    Step 4: Mount volumes

    You can add a volume directly or mount a ConfigMap or Secret. Alternatively, click Next directly to skip this step. For more information about volumes, visit Volumes.

    deployments

    Note

    Deployments can’t use a volume template, which is used by StatefulSets.

    Step 5: Configure advanced settings

    You can set a policy for node scheduling and add metadata in this section. When you finish, click Create to complete the whole process of creating a Deployment.

    deployments

    • Set Node Scheduling Policy

      You can allow Pod replicas to run on specified nodes. It is specified in the field nodeSelector.

    • Add Metadata

      Additional metadata settings for resources such as Labels and Annotations.

    Check Deployment Details

    Detail page

    1. After a Deployment is created, it will be displayed in the list as below. You can click on the right and select options from the menu to modify your Deployment.

      deployments

      • Edit: View and edit the basic information.
      • Edit YAML: View, upload, download, or update the YAML file.
      • Redeploy: Redeploy the Deployment.
      • Delete: Delete the Deployment.

    2. Click the name of the Deployment and you can go to its detail page.

      deployments

    3. Click More to display the operations about this Deployment you can do.

      deployments

      • Revision Rollback: Select the revision to roll back.
      • Horizontal Pod Autoscaling: Autoscale the replicas according to CPU and memory usage. If both CPU and memory are specified, replicas are added or deleted if any of the conditions is met.
      • Edit Config Template: Configure update strategies, containers and volumes.
      • Edit YAML: View, upload, download, or update the YAML file.
      • Redeploy: Redeploy this Deployment.
      • Delete: Delete the Deployment, and return to the Deployment list page.

    4. Click the Resource Status tab to view the port and Pod information of the Deployment.

      deployments

      • Replica Status: Click or to increase or decrease the number of Pod replicas.

      • Pod detail

        deployments

        • The Pod list provides detailed information of the Pod (status, node, Pod IP and resource usage).
        • You can view the container information by clicking a Pod item.
        • Click the container log icon to view output logs of the container.
        • You can view the Pod detail page by clicking the Pod name.

    Revision records

    After the resource template of workload is changed, a new log will be generated and Pods will be rescheduled for a version update. The latest 10 versions will be saved by default. You can implement a redeployment based on the change log.

    Matadata

    Click the Metadata tab to view the labels and annotations of the Deployment.

    deployments

    Monitoring

    1. Click the Monitoring tab to view the CPU usage, memory usage, outbound traffic, and inbound traffic of the Deployment.

      deployments

    2. Click the drop-down menu in the upper-right corner to customize the time range and time interval.

      deployments

    3. Click / in the upper-right corner to start/stop automatic data refreshing.

    4. Click in the upper-right corner to manually refresh the data.

    Environment variables

    Click the Environment Variables tab to view the environment variables of the Deployment.

    deployments

    Events

    Click the Events tab to view the events of the Deployment.

    deployments


    Thanks for the feedback. If you have a specific question about how to use KubeSphere, ask it on Slack. Open an issue in the GitHub repo if you want to report a problem or suggest an improvement.

    Previous : Create a Microservices-based App
    What’s on this Page