logo
Alauda Container Platform
English
简体中文
English
简体中文
logo
Alauda Container Platform
导航

概览

架构
发版日志

安装

概览

安装准备

前提条件
下载
节点预处理
安装
Global Cluster 灾难恢复

升级

概览
升级前准备
升级 global 集群
升级业务集群

用户界面

Web 控制台

概览
访问 Web 控制台
Customizing the Web Console
自定义左侧导航

CLI 工具

ACP CLI (ac)

使用 ACP CLI 入门
配置 ACP CLI
ac 和 kubectl 命令的使用
管理 CLI 配置文件
使用插件扩展 ACP CLI
AC CLI 开发者命令参考
AC CLI 管理员命令参考
violet CLI

配置

功能开关

集群

概览
不可变基础设施

节点管理

概览
向本地集群添加节点
管理节点
节点监控

托管集群

概述

导入集群

概览
导入标准 Kubernetes 集群
导入 OpenShift 集群
导入 Amazon EKS 集群
导入 GKE 集群
导入华为云 CCE 集群(公有云)
导入 Azure AKS 集群
导入阿里云 ACK 集群
导入腾讯云 TKE 集群
注册集群

公有云集群初始化

网络初始化

AWS EKS 集群网络初始化配置
AWS EKS 补充信息
华为云 CCE 集群网络初始化配置
Azure AKS 集群网络初始化配置
Google GKE 集群网络初始化配置

存储初始化

概览
AWS EKS 集群存储初始化配置
华为云 CCE 集群存储初始化配置
Azure AKS 集群存储初始化配置
Google GKE 集群存储初始化配置

如何操作

导入集群的网络配置
获取导入集群信息
信任不安全的镜像仓库
从自定义命名的网卡采集网络数据
创建本地集群
托管控制平面
集群节点规划
etcd 加密

如何操作

为内置镜像仓库添加外部访问地址
选择容器运行时
使用 Manager 策略优化 Pod 性能
更新公共仓库凭证

备份与恢复

概览
安装
备份仓库

备份管理

ETCD 备份
创建应用备份计划
钩子

恢复管理

运行应用恢复任务
镜像仓库替换

网络

操作指南

配置域名
创建证书
配置服务
配置 Ingresses
配置子网
配置 MetalLB
配置 GatewayAPI Gateway
配置 GatewayAPI 路由
配置 ALB
配置 NodeLocal DNSCache
配置 CoreDNS

实用指南

Ingress-Nginx 任务
Envoy Gateway 任务
软数据中心 LB 方案(Alpha)

Kube OVN

了解 Kube-OVN CNI
准备 Kube-OVN Underlay 物理网络
Underlay 和 Overlay 子网的自动互联
集群互联(Alpha)
配置 Egress Gateway
配置 IPPool
配置 Kube-OVN 网络以支持 Pod 多网卡(Alpha)
配置 Endpoint Health Checker

alb

Tasks for ALB

故障排除

如何解决 ARM 环境下的节点间通信问题?
查找错误原因

存储

介绍

核心概念

核心概念
Persistent Volume
访问模式和卷模式

操作指南

创建 CephFS 文件存储类型存储类
创建 CephRBD 块存储类
创建 TopoLVM 本地存储类
创建 NFS 共享存储类
部署 Volume Snapshot 组件
创建 PV
Creating PVCs
使用卷快照

实用指南

通用临时卷
使用 emptyDir
使用本地卷配置持久存储
使用 NFS 配置持久存储
第三方存储能力注解指南

故障排除

从 PVC 扩容失败中恢复

对象存储

介绍
核心概念
安装

操作指南

为 Ceph RGW 创建 BucketClass
为 MinIO 创建 BucketClass
创建 Bucket Request

实用指南

使用 CephObjectStoreUser(Ceph 驱动)控制 COSI 桶的访问权限和配额
机器配置

可扩展性与性能

评估业务集群资源
磁盘配置
评估 Global Cluster 的资源
提升大规模 Kubernetes 集群的稳定性

存储

Ceph 分布式存储

介绍

安装

创建标准型集群
创建 Stretch 类型集群
架构

核心概念

核心概念

操作指南

访问存储服务
存储池管理
节点特定组件部署
添加设备/设备类
监控与告警

实用指南

配置专用集群用于分布式存储
清理分布式存储

灾难恢复

文件存储灾备
块存储灾难恢复
对象存储灾备
更新优化参数
创建 Ceph 对象存储用户
设置存储池配额

MinIO 对象存储

介绍
安装
架构

核心概念

核心概念

操作指南

添加存储池
Monitoring & Alerts

实用指南

数据灾难恢复

TopoLVM 本地存储

介绍
安装

操作指南

设备管理
监控与告警

实用指南

使用 Velero 备份和恢复 TopoLVM 文件系统 PVC
配置条带逻辑卷

网络

概览

网络操作器

MetalLB Operator
Ingress Nginx Operator
Envoy Gateway Operator

ALB Operator

了解 ALB
Auth
为 ALB 部署高可用 VIP
在 ALB 中绑定网卡
ALB 性能选择的决策依据
ALB 中的负载均衡会话亲和策略
L4/L7 超时
HTTP 重定向
CORS
Header Modification
URL 重写
ModSecurity
OTel
TCP/HTTP Keepalive
ALB 与 Ingress-NGINX 注解兼容性
ALB 监控

网络安全

理解网络策略 API
管理员网络策略
网络策略

Ingress 和负载均衡

使用 Envoy Gateway 实现 Ingress 和负载均衡
网络可观测性

安全

Alauda Container Security

安全与合规

合规性

介绍
安装 Alauda Container Platform Compliance with Kyverno

使用指南

私有镜像仓库访问配置
镜像签名验证策略
使用 Secrets 的镜像签名验证策略
镜像仓库验证策略
容器逃逸防护策略
Security Context Enforcement Policy
网络安全策略
Volume Security Policy

API Refiner

介绍
安装 Alauda Container Platform API Refiner
关于 Alauda Container Platform Compliance Service

用户与角色

用户

介绍

操作指南

管理用户角色
创建用户
用户管理

组

介绍

操作指南

管理用户组角色
创建本地用户组
管理本地用户组成员

角色

介绍

操作指南

创建 Kubernetes 角色
RBAC 重构后的角色管理

IDP

介绍

操作指南

LDAP 管理
OIDC 管理

故障排除

删除用户

用户策略

介绍

多租户(项目)

介绍

操作指南

创建项目
管理项目配额
管理项目
管理项目集群
管理项目成员

审计

介绍

遥测

安装

证书

自动化 Kubernetes 证书轮换
cert-manager
OLM 证书
证书监控
轮换平台访问地址的 TLS 证书

虚拟化

虚拟化

概览

介绍
安装

镜像

介绍

操作指南

添加虚拟机镜像
更新/删除虚拟机镜像
更新/删除镜像凭据

实用指南

使用 KubeVirt 基于 ISO 创建 Windows 镜像
使用 KubeVirt 基于 ISO 创建 Linux 镜像
导出虚拟机镜像
权限

虚拟机

介绍

操作指南

创建虚拟机/虚拟机组
虚拟机批量操作
使用 VNC 登录虚拟机
管理密钥对
管理虚拟机
监控与告警
虚拟机快速定位

实用指南

配置 USB 主机直通
虚拟机热迁移
虚拟机恢复
在 KubeVirt 上克隆虚拟机
物理 GPU 直通环境准备
配置虚拟机高可用性
从现有虚拟机创建虚拟机模板

故障排除

Pod 迁移及虚拟机节点异常关闭恢复
热迁移错误信息及解决方案

网络

介绍

操作指南

配置网络

实用指南

通过网络策略控制虚拟机网络请求
配置 SR-IOV
配置虚拟机使用网络绑定模式以支持 IPv6

存储

介绍

操作指南

管理虚拟磁盘

备份与恢复

介绍

操作指南

使用快照
使用 Velero

开发人员

快速开始

Creating a simple application via image

构建应用

Build application architecture

核心概念

应用类型
Custom Applications
工作负载类型
理解参数
理解环境变量
理解启动命令
资源单位说明

命名空间

创建命名空间
导入 Namespace
资源配额
Limit Range
Pod Security Policies
UID/GID 分配
超售比
管理 Namespace 成员
更新命名空间
删除/移除命名空间

创建应用

Creating applications from Image
Creating applications from Chart
通过 YAML 创建应用
Creating applications from Code
Creating applications from Operator Backed
Creating applications by using CLI

应用的操作与维护

Application Rollout

安装 Alauda Container Platform Argo Rollouts
Application Blue Green Deployment
Application Canary Deployment
状态描述

KEDA(Kubernetes Event-driven Autoscaling)

KEDA 概览
Installing KEDA

实用指南

Integrating ACP Monitoring with Prometheus Plugin
在 KEDA 中暂停自动扩缩容
配置 HPA
启动和停止原生应用
配置 VerticalPodAutoscaler (VPA)
配置 CronHPA
更新原生应用
导出应用
更新和删除 Chart 应用
应用版本管理
删除原生应用
处理资源耗尽错误
健康检查

计算组件

Deployments
DaemonSets
StatefulSets
CronJobs
Jobs
Pods
Containers
使用 Helm Chart

配置

Configuring ConfigMap
Configuring Secrets

应用可观测

监控面板
Logs
Events

实用指南

设置定时任务触发规则
添加ImagePullSecrets到ServiceAccount

镜像

镜像概述

实用指南

Creating images
Managing images

镜像仓库

介绍

安装

通过 YAML 安装
通过 Web UI 安装

实用指南

Common CLI Command Operations
Using Alauda Container Platform Registry in Kubernetes Clusters

Source to Image

概览

介绍
架构
发版日志
生命周期策略

安装

Installing Alauda Container Platform Builds

升级

升级 Alauda Container Platform Builds

操作指南

Managing applications created from Code

实用指南

Creating an application from Code

节点隔离策略

介绍
架构

核心概念

Core Concepts

操作指南

创建节点隔离策略
权限
常见问题

Alauda Container Platform GitOps

关于 Alauda Container Platform GitOps

扩展

概览
Operator
集群插件
图表仓库
上架软件包

可观测性

概览

监控

介绍
安装

架构

Monitoring Module Architecture
Monitoring Component Selection Guide
监控组件容量规划
核心概念

操作指南

指标管理
告警管理
通知管理
监控面板管理
探针管理

实用指南

Prometheus 监控数据的备份与恢复
VictoriaMetrics 监控数据的备份与恢复
从自定义命名的网络接口采集网络数据

分布式追踪

介绍
安装
架构
核心概念

操作指南

Query Tracing
查询 Trace 日志

实用指南

Java 应用中追踪的非侵入式集成
业务日志与 TraceID 关联

故障排除

无法查询到所需的Tracing
不完整的追踪数据

日志

关于 Logging Service

事件

介绍
Events

检查

介绍
架构

操作指南

Inspection
Component Health Status

硬件加速器

关于 Alauda Build of Hami
关于 Alauda Build 的 NVIDIA GPU 设备插件

Alauda 服务网格

Service Mesh 1.x
Service Mesh 2.x

Alauda AI

关于 Alauda AI

Alauda DevOps

关于 Alauda DevOps

Alauda 成本管理

关于 Alauda 成本管理

Alauda 原生应用服务

概览

介绍
架构
安装
升级

Alauda Database Service for MySQL

About Alauda Database Service for MySQL-MGR
About Alauda Database Service for MySQL-PXC

Alauda Cache Service for Redis OSS

About Alauda Cache Service for Redis OSS

Alauda Streaming Service for Kafka

About Alauda Streaming Service for Kafka

Alauda Streaming Service for RabbitMQ

About Alauda Streaming Service for RabbitMQ

Alauda support for PostgreSQL

About Alauda support for PostgreSQL

运维管理

介绍

参数模板管理

介绍

操作指南

参数模板管理

备份管理

介绍

操作指南

外部 S3 存储
备份管理

检查管理

介绍

操作指南

创建巡检任务
Exec Inspection Task
更新和删除巡检任务

实用指南

如何设置巡检调度?

检查优化建议

MySQL

MySQL IO 负载优化
MySQL 内存使用优化
MySQL 存储空间优化
MySQL 活跃线程数优化
MySQL 行锁优化

Redis

Redis BigKey
Redis 中的高 CPU 使用率
Redis 中的高内存使用率

Kafka

Kafka 中的高 CPU 利用率
Kafka Rebalance 优化
Kafka 内存使用优化
Kafka 存储空间优化

RabbitMQ

RabbitMQ Mnesia 数据库异常处理

告警管理

介绍

操作指南

与平台能力的关系

升级管理

介绍

操作指南

实例升级

API 参考

概览

介绍
Kubernetes API 使用指南

Advanced APIs

Alert APIs

AlertHistories [v1]
AlertHistoryMessages [v1]
AlertStatus [v2]
SilenceStatus [v2]

Event APIs

Search

GitOps APIs

Core
Application
ApplicationSet

Log APIs

Aggregation
Archive
Context
Search

Monitoring APIs

Indicators [monitoring.alauda.io/v1beta1]
Metrics [monitoring.alauda.io/v1beta1]
Variables [monitoring.alauda.io/v1beta1]

Kubernetes APIs

Alert APIs

AlertTemplate [alerttemplates.aiops.alauda.io/v1beta1]
PrometheusRule [prometheusrules.monitoring.coreos.com/v1]

AutoScaling APIs

HorizontalPodAutoscaler [autoscaling/v2]

Configuration APIs

ConfigMap [v1]
Secret [v1]

Inspection APIs

Inspection [inspections.ait.alauda.io/v1alpha1]

MachineConfiguration APIs

MachineConfig [machineconfiguration.alauda.io/v1alpha1]
MachineConfigPool [machineconfiguration.alauda.io/v1alpha1]
MachineConfiguration [machineconfiguration.alauda.io/v1alpha1]

ModulePlugin APIs

ModuleConfig [moduleconfigs.cluster.alauda.io/v1alpha1]
ModuleInfo [moduleinfoes.cluster.alauda.io/v1alpha1]
ModulePlugin [moduleplugins.cluster.alauda.io/v1alpha1]

Namespace APIs

LimitRange [v1]
Namespace [v1]
ResourceQuota [v1]

Networking APIs

HTTPRoute [httproutes.gateway.networking.k8s.io/v1]
Service [v1]
VpcEgressGateway [vpc-egress-gateways.kubeovn.io/v1]
Vpc [vpcs.kubeovn.io/v1]

Notification APIs

Notification [notifications.ait.alauda.io/v1beta1]
NotificationGroup [notificationgroups.ait.alauda.io/v1beta1]
NotificationTemplate [notificationtemplates.ait.alauda.io/v1beta1]

Operator APIs

Operator [operators.operators.coreos.com/v1]

Workload APIs

Cronjob [batch/v1]
DameonSet [apps/v1]
Deployment [apps/v1]
Job [batch/v1]
Pod [v1]
Replicaset [apps/v1]
ReplicationController [v1]
Statefulset [apps/v1]
📝 在 GitHub 上编辑此页
上一页实用指南
下一页Managing images

以 PDF 格式查看完整文档

#Creating images

了解如何基于预构建镜像创建您自己的容器镜像,这些预构建镜像已准备好为您提供帮助。该过程包括学习编写镜像的最佳实践、定义镜像元数据、测试镜像,以及使用自定义构建流程创建可用于 Alauda Container Platform Registry 的镜像。创建镜像后,您可以将其推送到 Alauda Container Platform Registry。

#目录

#Learning container best practices

在为 Alauda Container Platform 创建容器镜像时,作为镜像作者需要考虑多项最佳实践,以确保镜像使用者获得良好体验。由于镜像旨在保持不可变且按原样使用,以下指南有助于确保您的镜像在 Alauda Container Platform 上具有高度可用性且易于使用。

#General container image guidelines

以下指南适用于一般容器镜像的创建,与镜像是否用于 Alauda Container Platform 无关。

复用镜像

尽可能基于合适的上游镜像使用 FROM 语句构建您的镜像。这确保您的镜像在上游镜像更新时能够轻松获取安全修复,而无需您直接更新依赖项。

此外,在 FROM 指令中使用标签,例如 alpine:3.20,可以让用户明确知道您的镜像基于哪个版本。使用非 latest 的标签可避免您的镜像受到上游镜像最新版本中可能引入的破坏性更改的影响。

保持标签内兼容性

为自己的镜像打标签时,尽量保持标签内的向后兼容性。例如,如果您提供了名为 image 的镜像,当前包含版本 1.0,您可以提供一个标签 image:v1。当您更新镜像时,只要保持与原始镜像兼容,您可以继续使用 image:v1 标签,下游使用该标签的用户可以无缝获取更新而不会出现兼容性问题。

如果之后发布了不兼容的更新,则切换到新标签,例如 image:v2。这允许下游用户根据需要升级到新版本,而不会被不兼容的更改意外破坏。使用 image:latest 的用户则承担了可能引入不兼容更改的风险。

避免多进程

不要在一个容器内启动多个服务,例如数据库和 SSHD。这没有必要,因为容器轻量且可以轻松链接以编排多个进程。Alauda Container Platform 允许您通过将相关镜像分组到单个 pod 中,轻松实现共置和共管。

这种共置确保容器共享网络命名空间和存储以进行通信。更新也更不具破坏性,因为每个镜像可以更少频率且独立地更新。单进程的信号处理流程也更清晰,无需管理信号路由到派生进程。

在包装脚本中使用 exec

许多镜像使用包装脚本在启动软件进程前进行一些设置。如果您的镜像使用此类脚本,脚本应使用 exec,以便脚本进程被您的软件进程替换。如果不使用 exec,容器运行时发送的信号会发送到包装脚本而非软件进程,这不是您想要的。

例如,您有一个包装脚本启动某个服务器进程。您使用 docker run -i 启动容器,运行包装脚本,包装脚本再启动服务器进程。如果您想用 CTRL+C 关闭容器,且包装脚本使用了 exec 启动服务器进程,docker 会向服务器进程发送 SIGINT,行为符合预期。如果未使用 exec,docker 会向包装脚本进程发送 SIGINT,服务器进程则继续运行。

另外,您的进程在容器中作为 PID 1 运行。这意味着如果主进程终止,整个容器会停止,您从 PID 1 进程启动的任何子进程也会被取消。

清理临时文件

删除构建过程中创建的所有临时文件,包括使用 ADD 命令添加的文件。例如,在执行 yum install 操作后运行 yum clean 命令。

您可以通过如下方式防止 yum 缓存进入镜像层:

RUN yum -y install mypackage && yum -y install myotherpackage && yum clean all -y

注意,如果写成:

RUN yum -y install mypackage
RUN yum -y install myotherpackage && yum clean all -y

则第一次 yum 调用会在该层留下额外文件,这些文件在后续运行 yum clean 时无法被删除。虽然这些文件在最终镜像中不可见,但它们存在于底层镜像层中。

当前容器构建流程不允许后续层运行的命令缩减前一层删除文件所占用的空间,但未来可能会改变。这意味着如果您在后续层执行 rm 命令,虽然文件被隐藏,但不会减少镜像下载的总体大小。因此,像 yum clean 示例一样,最好在创建文件的同一命令中删除它们,避免写入镜像层。

此外,在单个 RUN 语句中执行多个命令可以减少镜像层数,提升下载和解压速度。

按正确顺序排列指令

容器构建器从上到下读取 Dockerfile 并执行指令。每条成功执行的指令都会创建一个可被下次构建复用的层。将不常更改的指令放在 Dockerfile 顶部非常重要,这样后续构建时缓存不会被上层更改失效,构建速度更快。

例如,如果您在 Dockerfile 中有一个 ADD 命令安装您正在迭代的文件,以及一个 RUN 命令执行 yum install,最好将 ADD 命令放在最后:

FROM foo
RUN yum -y install mypackage && yum clean all -y
ADD myfile /test/myfile

这样每次编辑 myfile 并重新构建时,系统会重用 yum 命令的缓存层,只为 ADD 操作生成新层。

如果写成:

FROM foo
ADD myfile /test/myfile
RUN yum -y install mypackage && yum clean all -y

每次更改 myfile 并重新构建时,ADD 操作会使 RUN 层缓存失效,导致 yum 操作也必须重新执行。

标记重要端口

EXPOSE 指令使容器中的端口对主机系统和其他容器可用。虽然可以在 docker run 命令中指定端口暴露,但在 Dockerfile 中使用 EXPOSE 指令通过显式声明软件运行所需端口,使人和软件更容易使用您的镜像:

  • 暴露的端口会在 docker ps 中显示,关联到基于您的镜像创建的容器。
  • 暴露的端口存在于 docker inspect 返回的镜像元数据中。
  • 当链接容器时,暴露的端口会被自动连接。

设置环境变量

使用 ENV 指令设置环境变量是良好实践。例如设置项目版本号,方便用户无需查看 Dockerfile 即可了解版本。另一个例子是声明系统路径,如 JAVA_HOME,供其他进程使用。

避免默认密码

避免设置默认密码。许多人在扩展镜像时忘记移除或更改默认密码,这可能导致生产环境用户使用众所周知的密码,带来安全隐患。密码应通过环境变量进行配置。

如果确实设置了默认密码,确保容器启动时显示适当的警告信息,告知用户默认密码的值及如何更改,例如设置哪个环境变量。

避免 sshd

最好避免在镜像中运行 sshd。您可以使用 docker exec 访问本地主机上的容器,在集群中使用 kubectl exec 访问由 Alauda Container Platform 管理的容器。安装和运行 sshd 会增加攻击面并增加补丁负担。

使用卷存储持久数据

镜像应使用卷来存储持久数据。这样,Alauda Container Platform 会将网络存储挂载到运行容器的节点上,如果容器迁移到新节点,存储会重新挂载到该节点。通过使用卷存储所有持久数据,即使容器重启或迁移,内容也能保留。如果镜像将数据写入容器内任意位置,则无法保证数据持久性。

所有需要在容器销毁后仍保留的数据必须写入卷。容器引擎支持容器的 readonly 标志,可严格执行不向容器临时存储写数据的良好实践。现在围绕该能力设计镜像,未来更易利用。

在 Dockerfile 中显式定义卷,方便镜像使用者了解运行镜像时必须定义的卷。

有关卷在 Alauda Container Platform 中使用的更多信息,请参见 Kubernetes 文档。

注意:

即使使用持久卷,您的镜像的每个实例都有自己的卷,实例间文件系统不共享。这意味着卷不能用于集群中共享状态。

#Including metadata in images

定义镜像元数据有助于 Alauda Container Platform 更好地使用您的容器镜像,为开发者提供更佳体验。例如,您可以添加元数据提供镜像的有用描述,或建议可能还需要的其他镜像。

本主题仅定义当前用例所需的元数据,未来可能添加更多元数据或用例。

#Defining image metadata

您可以在 Dockerfile 中使用 LABEL 指令定义镜像元数据。标签类似于环境变量,是附加到镜像或容器的键值对。标签不同于环境变量的是,它们对运行中的应用不可见,且可用于快速查找镜像和容器。

有关 LABEL 指令的更多信息,请参见 Docker 文档。

标签名称通常带有命名空间。命名空间根据将使用标签的项目设置。对于 Kubernetes,命名空间为 io.k8s。

有关格式的详细信息,请参见 Docker 自定义元数据文档。