Alauda Container Platform

English

English
简体中文

Alauda Container Platform
API References
Kubernetes APIs
Inspection APIs

Cluster Management Models

Core and Extensions

Availability and Recovery

Version and Lifecycle

Kubernetes Support Matrix

Global Cluster Disaster Recovery

Prepare for Installation

Node Preprocessing

Prepare an External Platform Image Registry

Installer Parameters

Installation Troubleshooting

Pre-Upgrade Preparation

Upgrade the global cluster

Upgrade Global Clusters in a DR Environment

Upgrade Workload Clusters

Upgrade Validation

Upgrade Troubleshooting

Accessing the Web Console

Customizing the Web Console

Customizing the Left Navigation

New Web Console (Preview)

Installing and Accessing the New Web Console

Getting Started with ACP CLI

Configuring ACP CLI

Usage of ac and kubectl Commands

Managing CLI Profiles

Extending ACP CLI with Plugins

AC CLI Developer Command Reference

AC CLI Administrator Command Reference

Upgrading Clusters

Postinstallation Configuration

Prepare Users and Access

Prepare Networking

Prepare Storage

Prepare Registry

Configure Alert Notifications

Day-2 Operations

Immutable Infrastructure

Managed Clusters

Managed Clusters

Import Third-Party Clusters

Import Third-Party Clusters

Import Standard Kubernetes Cluster

Import OpenShift Cluster

Import Amazon EKS Cluster

Import GKE Cluster

Import Huawei Cloud CCE Cluster (Public Cloud)

Import Azure AKS Cluster

Import Alibaba Cloud ACK Cluster

Import Tencent Cloud TKE Cluster

Register Cluster

Public Cloud Cluster Initialization

Network Initialization

AWS EKS Cluster Network Initialization Configuration

AWS EKS Supplementary Information

Huawei Cloud CCE Cluster Network Initialization Configuration

Azure AKS Cluster Network Initialization Configuration

Google GKE Cluster Network Initialization Configuration

Storage Initialization

AWS EKS Cluster Storage Initialization Configuration

Huawei Cloud CCE Cluster Storage Initialization Configuration

Azure AKS Cluster Storage Initialization Configuration

Google GKE Cluster Storage Initialization Configuration

Network Configuration for Imported Clusters

Fetch import cluster information

Trust an insecure image registry

Collect Network Data from Custom Named Network Cards

Configure audit collection for imported standard Kubernetes clusters

Creating an On-Premise Cluster

Add External Address for Built-in Registry

Updating Public Repository Credentials

Access a Cluster with KubeConfig

Hosted Control Planes

Add Nodes to On-Premises Clusters

Plan an In-Place OS Upgrade for Nodes

Node Monitoring

Cluster Node Planning

etcd Encryption

Backup and Restore

etcd Backup and Restore

Application Backup and Restore

Backup repository

Create an application backup schedule

Run an Application Restore Task

Image Registry Replacement

Persistent Volume

Access Modes and Volume Modes

Creating CephFS File Storage Type Storage Class

Creating CephRBD Block Storage Class

Create TopoLVM Local Storage Class

Creating an NFS Shared Storage Class

Deploy Volume Snapshot Component

Using Volume Snapshots

Generic ephemeral volumes

Using an emptyDir

Migrate the Volume Snapshot Component from the Legacy Plugin

Configuring Persistent Storage Using Local volumes

Configuring Persistent Storage Using NFS

Configuring Disaster Recovery For Persistent Volume Claims

Third‑Party Storage Capability Annotation Guide

Troubleshooting

Recover From PVC Expansion Failure

Detach CSI Volumes After Non-Graceful Node Shutdown

Creating a BucketClass for Ceph RGW

Create a Bucket Request

Control Access & Quotas for COSI Buckets with CephObjectStoreUser (Ceph Driver)

Registry Administration

Registry Data Backup and Recovery

Registry v2 Administration

Registry v2: Image Registry Overview

Registry v2: Image Registry Operator

Registry v2: Setting Up and Configuring the Registry

Registry v2: Exposing the Registry

Registry v2: Managing Access and Cleanup

Install by Using YAML

Install by Using the Web Console

Upgrade Registry

Platform Settings

Machine Configuration

Scalability and Performance

Evaluating Resources for Workload Cluster

Evaluating Resources for Global Cluster

Optimize Pod Performance with Manager Policies

Improving Kubernetes Stability for Large-Scale Clusters

Disk Configuration

Storage Systems

Ceph Distributed Storage

Planning Your Deployment

Deploying in Internal Mode

Deploying in External Mode

Create Stretch Type Cluster

Managing Storage Pools

Node-specific Component Deployment

Adding Devices/Device Classes

Monitoring and Alerts

Replacing or Removing Devices

Replacing or Removing Storage Nodes

Configure a Dedicated Cluster for Distributed Storage

Cleanup Distributed Storage

Disaster Recovery

File Storage Disaster Recovery

Block Storage Disaster Recovery

Object Storage Disaster Recovery

Update the optimization parameters

Create Ceph Object Store User

Setting Storage Pool Quotas

Enabling D3N Cache for Ceph RGW

Configure in-transit encryption

Setting Ceph OSD Full Thresholds

Persistent volume encryption

Configuring OSD WAL and DB Partitions

Configure Multus multi-NIC networking

MinIO to Rook Ceph RGW Data Migration Guide

TopoLVM Local Storage

Device Management

Monitoring and Alerting

Backup and Restore TopoLVM Filesystem PVCs with Velero

Remove Disks, Device-Class Volume Groups, or Nodes from ACP TopoLVM Local Storage

Configuring Striped Logical Volumes

Networking Operators

MetalLB Operator

Ingress Nginx Operator

Envoy Gateway Operator

Understanding ALB

Deploy High Available VIP for ALB

Bind NIC in ALB

Decision‑Making for ALB Performance Selection

Load Balancing Session Affinity Policy in ALB

Header Modification

TCP/HTTP Keepalive

ALB with Ingress-NGINX Annotation Compatibility

Network Security

Understanding Network Policy APIs

Admin Network Policy

Ingress and Load Balancing

Ingress and Load Balancing with Envoy Gateway

Configure Domain

Creating Certificates

Configure Services

Configure Ingresses

Configure Subnets

Configure MetalLB

Configure GatewayAPI Gateway

Configure GatewayAPI Policy

Configure GatewayAPI Route

Configure NodeLocal DNSCache

Configure CoreDNS

Network Observability

Tasks for Ingress-Nginx

Tasks for Envoy Gateway

Soft Data Center LB Solution (Alpha)

Understanding Kube-OVN CNI

Preparing Kube-OVN Underlay Physical Network

Kube-OVN Underlay + MetalLB LoadBalancer Service Configuration

Cluster Interconnection (Alpha)

Configure Egress Gateway

Configuring Kube-OVN Network to Support Pod Multi-Network Interfaces

Configure Centralized Gateway

Configure IPPool

Automatic Interconnection of Underlay and Overlay Subnets

Configure Endpoint Health Checker

alb

Task: Migrate from OCP Route to GatewayAPI Route

Trouble Shooting

How to Solve Inter-node Communication Issues in ARM Environments?

Find Who Cause the Error

Alauda Container Security

Alauda Cluster Authentication

Security and Compliance

Install Alauda Container Platform Compliance with Kyverno

Private Registry Access Configuration

Apply Security Context Constraints for Pod Security

Image Signature Verification Policy

Image Signature Verification Policy with Secrets

Image Registry Validation Policy

Container Escape Prevention Policy

Security Context Enforcement Policy

Network Security Policy

Volume Security Policy

Kyverno Policy Configuration Use Cases

Use Kyverno Generate Rules

Install Alauda Container Platform API Refiner

About Alauda Container Platform Compliance Service

Platform Security Configurations

Changing the Platform OIDC Client Secret

Disabling the PKCE Plain Method

Users and Roles

Manage User Roles

User Management

Obtain an API Access Token

Manage User Group Roles

Create Local User Group

Manage Local User Group Membership

Create Kubernetes Roles

How to Create Custom Platform Role

LDAP Management

OIDC Management

Troubleshooting

Multitenancy(Project)

Manage Project Quotas

Manage Project Cluster

Manage Project Members

Automated Kubernetes Certificate Rotation

OLM Certificates

Certificate Monitoring

Rotate TLS Certs of Platform Access Addresses

Concepts and Glossary

Adding Virtual Machine Images

Update/Delete Virtual Machine Images

Update/Delete Image Credentials

Uploading a Local Image and Creating a Virtual Machine

Creating Windows Images Based on ISO using KubeVirt

Creating Linux Images Based on ISO Using KubeVirt

Exporting Virtual Machine Images

Virtual Machine

Bootable Volumes

Creating Virtual Machines

Batch Operations on Virtual Machines

Pausing and Resuming a Virtual Machine

Cloning a Virtual Machine

Logging into the Virtual Machine using VNC

Managing Key Pairs

Managing Virtual Machines

Monitoring and Alerts

Quick Location of Virtual Machines

Using the virtctl Command-Line Tool

Configuring USB host passthrough

Installing Guest Tools (Guest Agent, VirtIO Drivers, vTPM)

Virtual Machine Live Migration

CPU and Memory Hotplug

Virtual Machine Recovery

Clone Virtual Machines on KubeVirt

Migrate Virtual Machines Between Storage Classes

Configuring High Availability for Virtual Machines

Create a VM Template from an Existing Virtual Machine

Troubleshooting

Pod Migration and Recovery from Abnormal Shutdown of Virtual Machine Nodes

Live Migration Error Messages and Solutions

Troubleshooting Boot and Image Import

Configure Network

Control Virtual Machine Network Requests Through Network Policy

Configuring SR-IOV

Configuring Virtual Machines to Use Network Binding Mode for IPv6 Support

Configuring Multi-NIC Virtual Machine

Managing Virtual Disks

Backup and Recovery

Using Snapshots

Creating a simple application via image

Building Applications

Build application architecture

Application Types

Custom Applications

Understanding Parameters

Understanding Environment Variables

Understanding Startup Commands

Resource Unit Description

Creating Namespaces

Importing Namespaces

Pod Security Policies

UID/GID Assignment

Overcommit Ratio

Managing Namespace Members

Updating Namespaces

Deleting/Removing Namespaces

Creating Applications

Creating applications from Image

Creating applications from Chart

Creating applications from YAML

Creating applications from Code

Creating applications from Operator Backed

Creating applications by using CLI

Operation and Maintaining Applications

Application Rollout

Installing Alauda Container Platform Argo Rollouts

Application Blue Green Deployment

Application Canary Deployment

Status Description

Configuring HPA

Starting and Stopping Applications

Configuring VerticalPodAutoscaler (VPA)

Configuring CronHPA

Updating Applications

Exporting Applications

Updating and deleting Chart Applications

Workload Rebalancing (Descheduler)

Version Management for Applications

Deleting Applications

Using PodDisruptionBudgets

Dynamically Inject PSA Security Contexts for Workloads

Handling Out of Resource Errors

Adjust Pod Resource Levels Without Pod Disruption

Working with Helm charts

Configuring ConfigMap

Configuring Secrets

Application Observability

Monitoring Dashboards

Setting Scheduled Task Trigger Rules

Add ImagePullSecrets to ServiceAccount

Service Serving Certificate

Overview of images

Creating images

Managing images

Registry Image Use

Registry v2: Image Use

Registry v2: Accessing the Registry

Registry v2: Managing Images with ac

Common CLI Command Operations

Using Alauda Container Platform Registry in Kubernetes Clusters

Configure Registry Push Limits

Source to Image

Lifecycle Policy

Installing Alauda Container Platform Builds

Upgrading Alauda Container Platform Builds

Managing applications created from Code

Creating an application from Code

Node Isolation Strategy

Create Node Isolation Strategy

Manage Node Isolation Policies with the CLI

Chart Repository

Download Packages

Upload Packages

Cluster Notification

Monitoring Module Architecture

Monitoring Component Selection Guide

Monitor Component Capacity Planning

Management of Metrics

Management of Alert

Management of Notification

Management of Monitoring Dashboards

Perses Monitoring Dashboards

Fleet Monitoring

Management of Probe

Backup and Restore of Prometheus Monitoring Data

VictoriaMetrics Backup and Recovery of Monitoring Data

Collect Network Data from Custom-Named Network Interfaces

Planning Infra Nodes for Monitoring

Configure Fleet Monitoring

Migrate MonitorDashboard to Perses

Distributed Tracing

About Distributed Tracing

Alauda Build of OpenTelemetry

About Alauda Build of OpenTelemetry

About Logging Service

Component Health Status

Hardware accelerators

RuntimeClass and CDI

Accelerator Quota

Accelerator Monitoring

Vendor Integrations

Sharing and Scheduling

Alauda Service Mesh

About Service Mesh

About Alauda AI

About Alauda DevOps

Alauda Cost Management

About Alauda Cost Management

Alauda Application Services

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 Cache Service E2

About Alauda Cache Service E2

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

About Alauda support for CloudNativePG

Alauda Build of Keycloak

About Alauda Build of Keycloak

Operations Management

Parameter Template Management

Parameter Template Management

Backup Management

External S3 Storage

Backup Management

Inspection Management

Create Inspection Task

Exec Inspection Task

Update and Delete Inspection Tasks

How to set Inspection scheduling?

Inspection Optimization Recommendations

MySQL IO Load Optimization

MySQL Memory Usage Optimization

MySQL Storage Space Optimization

MySQL Active Thread Count Optimization

MySQL Row Lock Optimization

High CPU Usage in Redis

High Memory Usage in Redis

High CPU Utilization in Kafka

Kafka Rebalance Optimization

Kafka Memory Usage Optimization

Kafka Storage Space Optimization

RabbitMQ Mnesia Database Exception Handling

Alert Management

Relationship with Platform Capabilities

Upgrade Management

Instance Upgrade

Alauda Container Platform GitOps

About Alauda Container Platform GitOps

Alauda Hyperflux

About Alauda Hyperflux

Kubernetes API Usage Guide

Cluster Lifecycle APIs

Cluster [platform.tkestack.io/v1]

ClusterCredential [platform.tkestack.io/v1]

Machine [platform.tkestack.io/v1]

AlertHistories [v1]

AlertHistoryMessages [v1]

AlertStatus [v2]

SilenceStatus [v2]

Application APIs

Application Lifecycle

Application Management Operations

Application Query and Resources

Monitoring APIs

Indicators [monitoring.alauda.io/v1beta1]

Metrics [monitoring.alauda.io/v1beta1]

Variables [monitoring.alauda.io/v1beta1]

UserBinding [v2]

AccessToken [v1]

Kubernetes APIs

Backup [velero.io/v1]

BackupRepository [velero.io/v1]

BackupStorageLocation [velero.io/v1]

DataDownload [velero.io/v2alpha1]

DataUpload [velero.io/v2alpha1]

DeleteBackupRequest [velero.io/v1]

DownloadRequest [velero.io/v1]

PodVolumeBackup [velero.io/v1]

PodVolumeRestore [velero.io/v1]

Restore [velero.io/v1]

Schedule [velero.io/v1]

ServerStatusRequest [velero.io/v1]

VolumeSnapshotLocation [velero.io/v1]

EtcdCluster [operator.etcd.io/v1alpha1]

Marketplace APIs

Artifact [app.alauda.io/v1alpha1]

ArtifactVersion [app.alauda.io/v1alpha1]

Chart [app.alauda.io/v1alpha1]

ChartRepo [app.alauda.io/v1alpha1]

HelmRequest [app.alauda.io/v1]

ImageWhiteList [app.alauda.io/v1alpha1]

Library [app.alauda.io/v1alpha1]

Platform Base APIs

ClusterModule [cluster.alauda.io/v1alpha1]

CommonConfig [operator.alauda.io/v1alpha1]

ProductBase [product.alauda.io/v1alpha1]

ProductConfig [alauda.io/v1alpha1]

ProductUpgrade [product.alauda.io/v1alpha1]

Platform Cluster APIs

AlaudaFeatureGate [alauda.io/v1]

AlertRule [ait.alauda.io/v1]

ClusterAlaudaFeatureGate [alauda.io/v1]

Dashboard [ait.alauda.io/v1alpha1]

DisableToken [auth.alauda.io/v1]

DisableUser [auth.alauda.io/v1]

Feature [infrastructure.alauda.io/v1alpha1]

GrafanaDashboard [ait.alauda.io/v1beta1]

ImageVersion [middleware.alauda.io/v1]

MonitorDashboard [ait.alauda.io/v1alpha1]

ProductEntry [alauda.io/v1alpha1]

Project [auth.alauda.io/v1]

User [auth.alauda.io/v1]

UserBinding [auth.alauda.io/v1]

EtcdEncryptionConfig [cluster.alauda.io/v1alpha1]

Virtualization APIs

VirtualMachine [virtualmachines.kubevirt.io/v1]

VirtualMachineInstance [virtualmachineinstances.kubevirt.io/v1]

VirtualMachineInstanceMigration [virtualmachineinstancemigrations.kubevirt.io/v1]

VirtualMachineClone [virtualmachineclones.clone.kubevirt.io/v1beta1]

VirtualMachineSnapshot [virtualmachinesnapshots.snapshot.kubevirt.io/v1beta1]

VirtualMachineRestore [virtualmachinerestores.snapshot.kubevirt.io/v1beta1]

DataVolume [datavolumes.cdi.kubevirt.io/v1beta1]

DataSource [datasources.cdi.kubevirt.io/v1beta1]

MigrationPolicy [migrationpolicies.migrations.kubevirt.io/v1alpha1]

VirtualMachineStorageMigrationPlan [virtualmachinestoragemigrationplans.migrations.kubevirt.io/v1alpha1]

VirtualMachineStorageMigration [virtualmachinestoragemigrations.migrations.kubevirt.io/v1alpha1]

VirtualMachineExport [virtualmachineexports.export.kubevirt.io/v1beta1]

HyperConverged [hyperconvergeds.hco.kubevirt.io/v1beta1]

VirtualMachineClusterInstancetype [virtualmachineclusterinstancetypes.instancetype.kubevirt.io/v1beta1]

VirtualMachineClusterPreference [virtualmachineclusterpreferences.instancetype.kubevirt.io/v1beta1]

AlertTemplate [alerttemplates.aiops.alauda.io/v1beta1]

PrometheusRule [prometheusrules.monitoring.coreos.com/v1]

AutoScaling APIs

HorizontalPodAutoscaler [autoscaling/v2]

Cluster Version APIs

ProductManifest [config.alauda.io/v1]

ClusterVersionShadow [config.alauda.io/v1]

Configuration APIs

Connector [dex.coreos.com/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]

LimitRange [v1]

ResourceQuota [v1]

Networking APIs

HTTPRoute [httproutes.gateway.networking.k8s.io/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]

CatalogSource [operators.coreos.com/v1alpha1]

ClusterServiceVersion [operators.coreos.com/v1alpha1]

InstallPlan [operators.coreos.com/v1alpha1]

OLMConfig [operators.coreos.com/v1]

OperatorCondition [operators.coreos.com/v1]

OperatorGroup [operators.coreos.com/v1]

Subscription [operators.coreos.com/v1alpha1]

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

PodDisruptionBudget [policy/v1]

Project [auth.alauda.io/v1]

ClusterRole [rbac.authorization.k8s.io/v1]

ClusterRoleBinding [rbac.authorization.k8s.io/v1]

Role [rbac.authorization.k8s.io/v1]

RoleBinding [rbac.authorization.k8s.io/v1]

RoleTemplate [auth.alauda.io/v1beta1]

ServiceAccount APIs

ServiceAccount [v1]

TokenRequest [authentication.k8s.io/v1]

PersistentVolumeClaim [v1]

PersistentVolume [v1]

StorageClass [storage.k8s.io/v1]

Ceph Storage APIs

CephCluster [cephclusters.ceph.rook.io/v1]

CephFilesystem [cephfilesystems.ceph.rook.io/v1]

CephBlockPool [cephblockpools.ceph.rook.io/v1]

CephObjectStore [cephobjectstores.ceph.rook.io/v1]

CephObjectStoreUser [cephobjectstoreusers.ceph.rook.io/v1]

AccessTokenInfo [auth.alauda.io/v1]

User [auth.alauda.io/v1]

CronJob [batch/v1]

DaemonSet [apps/v1]

Deployment [apps/v1]

Replicaset [apps/v1]

ReplicationController [v1]

StatefulSet [apps/v1]

Inspection APIs

Previous pageConnector [dex.coreos.com/v1]Next pageInspection [inspections.ait.alauda.io/v1alpha1]

View full docs as PDF