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

产品概览

架构
发版日志

安装

概览

安装准备

前提条件
下载
节点预处理
安装
global 集群灾难恢复

升级

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

用户界面

灵雀控制台

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

CLI 工具

ACP CLI (ac)

Getting Started with 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 加密

实用指南

为内置注册表添加外部地址
选择容器运行时
更新公共仓库凭证

备份与恢复

概览
安装
备份仓库

备份管理

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

恢复管理

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

网络

介绍

架构

理解 Kube-OVN
理解 ALB
了解 MetalLB

核心概念

ALB 与 Ingress-NGINX 注解兼容性
Service、Ingress、Gateway API 与 ALB Rule 之间的比较
GatewayAPI

功能指南

创建服务
创建 Ingress
创建域名
创建证书
创建外部 IP 地址池
创建 BGP Peers
配置子网
配置网络策略
创建 Admin 网络策略
配置 Kube-OVN 网络以支持 Pod 多网卡(Alpha)
配置集群网络策略
配置 Egress Gateway
网络可观测性
配置 ALB 规则
集群互联(Alpha)
Endpoint Health Checker
NodeLocal DNSCache

如何操作

准备 Kube-OVN Underlay 物理网络
软数据中心 LB 方案(Alpha)
Underlay 和 Overlay 子网的自动互联
通过集群插件安装 Ingress-Nginx
通过 Ingress Nginx Operator 安装 Ingress-Nginx
Ingress-Nginx 的任务

ALB

Auth
部署 ALB 的高可用 VIP
Header Modification
HTTP 重定向
L4/L7 超时
ModSecurity
TCP/HTTP Keepalive
使用 OAuth Proxy 配合 ALB
通过 ALB 配置 GatewayApi Gateway
在 ALB 中绑定网卡
ALB 性能选择决策
部署 ALB
通过 ALB 将 IPv6 流量转发到集群内的 IPv4 地址
OTel
ALB 监控
CORS
ALB 中的负载均衡会话亲和策略
URL 重写
Calico 网络支持 WireGuard 加密
Kube-OVN Overlay 网络支持 IPsec 加密
DeepFlow 用户指南

故障排除

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

存储

介绍

概念

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

功能指南

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

实用指南

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

故障排除

从 PVC 扩容失败中恢复
机器配置

可扩展性与性能

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

存储

Ceph 分布式存储

介绍

安装

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

核心概念

核心概念

操作指南

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

实用指南

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

数据容灾

文件存储灾备
块存储灾难恢复
对象存储灾难恢复
更新优化参数
创建 ceph 对象存储用户

MinIO 对象存储

介绍
安装
架构

核心概念

核心概念

操作指南

添加存储池
Monitoring & Alerts

实用指南

数据灾难恢复

TopoLVM 本地存储

介绍
安装

操作指南

设备管理
监控与告警

实用指南

使用 Velero 备份和恢复 TopoLVM 文件系统 PVC

安全

Alauda Container Security

安全性与合规性

合规

介绍
安装 Alauda Container Platform Compliance with Kyverno

使用指南

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

API Refiner

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

用户与角色

用户

介绍

功能指南

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

用户组

介绍

功能指南

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

角色

介绍

功能指南

创建角色
管理自定义角色

IDP

介绍

功能指南

LDAP 管理
OIDC 管理

故障排除

删除用户

用户策略

介绍

多租户(项目)

介绍

功能指南

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

审计

介绍

遥测

安装

证书

自动化 Kubernetes 证书轮换
cert-manager
OLM 证书
证书监控

虚拟化

虚拟化

概览

介绍
安装

镜像

介绍

操作指南

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

实用指南

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

虚拟机

介绍

操作指南

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

实用指南

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

问题处理

虚拟机节点正常关机下的 Pod 迁移及异常宕机恢复问题
热迁移错误信息及解决方案

网络

介绍

操作指南

配置网络

实用指南

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

存储

介绍

操作指南

管理虚拟磁盘

备份和恢复

介绍

操作指南

使用快照

开发者

快速开始

Creating a simple application via image

构建应用

Build application architecture

核心概念

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

命名空间

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

创建应用

Creating applications from Image
Creating applications from Chart
通过 YAML 创建应用
通过代码创建应用
Creating applications from Operator Backed
通过 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
任务
Pods
Containers
使用 Helm charts

配置

Configuring ConfigMap
Configuring Secrets

应用可观测

监控面板
Logs
实时事件

实用指南

设置定时任务触发规则

镜像

镜像概述

实用指南

Creating images
Managing images

镜像仓库

介绍

安装

通过 YAML 安装
通过 Web UI 安装

使用指南

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

S2I

概览

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

安装

Installing Alauda Container Platform Builds

升级

升级 Alauda Container Platform Builds

功能指南

Managing applications created from Code

How To

通过代码创建应用

节点隔离策略

引言
架构

概念

核心概念

功能指南

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

GitOps

介绍

安装

Installing Alauda Build of Argo CD
Installing Alauda Container Platform GitOps

升级

Upgrading Alauda Container Platform GitOps
架构

核心概念

GitOps

Argo CD 核心概念

Argo CD Introduction
Application 概念
ApplicationSet 概念
Tool
Helm 概念
Kustomize 概念
Directory 概念
Sync 概念
Health 概念

Alauda Container Platform GitOps 核心概念

介绍
Alauda Container Platform GitOps 的同步及健康检查

功能指南

创建 GitOps 应用

Creating GitOps Application
Creating GitOps ApplicationSet

GitOps 可观测

Argo CD 组件监控
GitOps 应用运维

实用指南

通过 Argo CD Dashboard 集成代码仓库
通过 Argo CD dashboard 创建 Argo CD Application
通过平台创建 Argo CD Application
如何获取 Argo CD 访问信息
故障排查

扩展

概览
Operator
集群插件
上架软件包

可观测性

概览

监控

介绍
安装

架构

监控模块架构
Monitoring Component Selection Guide
Monitor 组件容量规划
核心概念

操作指南

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

实用指南

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

调用链

介绍
安装
架构
核心概念

操作指南

查询追踪
查询追踪日志

实用指南

Java 应用无侵入方式接入调用链
与 TraceID 相关的业务日志

问题处理

查询不到所需的调用链
调用链数据不完整

日志

介绍
安装

架构

日志模块架构
日志组件选择指南
日志组件容量规划
概念

操作指南

日志

实用指南

如何将日志归档至第三方存储
如何对接外部 ES 存储集群

事件

介绍
Events

巡检

介绍
架构

操作指南

巡检
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

关于灵雀云 DevOps

Alauda 计量计费

关于 Alauda 成本管理

Alauda 应用服务

概览

介绍
架构
安装
升级

Alauda Database Service for MySQL

关于 Alauda Database Service for MySQL-MGR
关于 Alauda Database Service for MySQL-PXC

Alauda Cache Service for Redis OSS

关于 Alauda Cache Service for Redis OSS

Alauda Streaming Service for Kafka

About Alauda Streaming Service for Kafka

Alauda Streaming Service for RabbitMQ

关于 Alauda Streaming Service for RabbitMQ

Alauda support for PostgreSQL

关于 Alauda support for PostgreSQL

运维管理

介绍

参数模板管理

介绍

功能指南

参数模板管理

备份管理

介绍

功能指南

外部 S3 存储
备份管理

检查管理

介绍

操作指南

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

实用指南

如何设置检查调度?

检查优化建议

MySQL

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

Redis

Redis 大键
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

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]

Inspection APIs

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

Notification APIs

Notification [notifications.ait.alauda.io/v1beta1]
NotificationGroup [notificationgroups.ait.alauda.io/v1beta1]
NotificationTemplate [notificationtemplates.ait.alauda.io/v1beta1]
📝 在 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 顶部非常重要,这样下一次构建相同镜像时缓存不会因上层更改而失效,构建速度更快。

例如,如果您正在编写包含 ADD 命令安装您正在迭代的文件和 RUN 命令安装软件包的 Dockerfile,最好将 ADD 命令放在最后:

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

这样每次编辑 myfile 并重新运行 docker build 时,系统会复用 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 命令访问本地主机上运行的容器,或访问运行在 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 自定义元数据文档。