Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/en/apis/advanced_apis/event/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,9 @@ i18n:

# Search

<OpenAPIPath path="/platform/events.alauda.io/v1/events"/>
<OpenAPIPath path="/platform/events.alauda.io/v1/projects/{project}/clusters/{cluster}/namespaces/{namespace}/events"/>
<OpenAPIPath
path={[
'/platform/events.alauda.io/v1/events',
'/platform/events.alauda.io/v1/projects/{project}/clusters/{cluster}/namespaces/{namespace}/events',
]}
/>
10 changes: 7 additions & 3 deletions docs/en/apis/advanced_apis/log/aggregation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ i18n:

# Aggregation

<OpenAPIPath path="/platform/logging.alauda.io/v2/logs/aggregation"/>
<OpenAPIPath path="/platform/logging.alauda.io/v2/clusters/{cluster}/logs/aggregation"/>
<OpenAPIPath path="/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/aggregation"/>
<OpenAPIPath
path={[
'/platform/logging.alauda.io/v2/logs/aggregation',
'/platform/logging.alauda.io/v2/clusters/{cluster}/logs/aggregation',
'/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/aggregation',
]}
/>
10 changes: 7 additions & 3 deletions docs/en/apis/advanced_apis/log/archive.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ i18n:

# Archive

<OpenAPIPath path="/platform/logging.alauda.io/v2/logs/archive"/>
<OpenAPIPath path="/platform/logging.alauda.io/v2/clusters/{cluster}/logs/archive"/>
<OpenAPIPath path="/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/archive"/>
<OpenAPIPath
path={[
'/platform/logging.alauda.io/v2/logs/archive',
'/platform/logging.alauda.io/v2/clusters/{cluster}/logs/archive',
'/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/archive',
]}
/>
10 changes: 7 additions & 3 deletions docs/en/apis/advanced_apis/log/context.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ i18n:

# Context

<OpenAPIPath path="/platform/logging.alauda.io/v2/logs/context"/>
<OpenAPIPath path="/platform/logging.alauda.io/v2/clusters/{cluster}/logs/context"/>
<OpenAPIPath path="/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/context"/>
<OpenAPIPath
path={[
'/platform/logging.alauda.io/v2/logs/context',
'/platform/logging.alauda.io/v2/clusters/{cluster}/logs/context',
'/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/context',
]}
/>
10 changes: 7 additions & 3 deletions docs/en/apis/advanced_apis/log/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,10 @@ i18n:

# Search

<OpenAPIPath path="/platform/logging.alauda.io/v2/logs/search"/>
<OpenAPIPath path="/platform/logging.alauda.io/v2/clusters/{cluster}/logs/search"/>
<OpenAPIPath path="/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/search"/>
<OpenAPIPath
path={[
'/platform/logging.alauda.io/v2/logs/search',
'/platform/logging.alauda.io/v2/clusters/{cluster}/logs/search',
'/platform/logging.alauda.io/v2/projects/{project}/clusters/{cluster}/namespaces/{namespace}/logs/search',
]}
/>
12 changes: 7 additions & 5 deletions docs/en/apis/advanced_apis/monitor/indicators.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@ sourceSHA: 16d2d3fa23c37585a14f34f86ceb05542f035409d29c5e91b4f3e6da53167fa1

# Indicators [monitoring.alauda.io/v1beta1]

<OpenAPIPath path="/platform/monitoring.alauda.io/v1beta1/clusters/{cluster}/indicators" />

<OpenAPIPath path="/platform/monitoring.alauda.io/v1beta1/projects/{project}/indicators" />

<OpenAPIPath path="/platform/monitoring.alauda.io/v1beta1/projects/{project}/clusters/{cluster}/namespaces/{namespace}/indicators" />
<OpenAPIPath
path={[
'/platform/monitoring.alauda.io/v1beta1/clusters/{cluster}/indicators',
'/platform/monitoring.alauda.io/v1beta1/projects/{project}/indicators',
'/platform/monitoring.alauda.io/v1beta1/projects/{project}/clusters/{cluster}/namespaces/{namespace}/indicators',
]}
/>
12 changes: 7 additions & 5 deletions docs/en/apis/advanced_apis/monitor/metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@ sourceSHA: 8fda8bb72100def30b6a497567611e9df184d1785a4fa920383613ef10b811dc

# Metrics [monitoring.alauda.io/v1beta1]

<OpenAPIPath path="/platform/monitoring.alauda.io/v1beta1/clusters/{cluster}/metrics" />

<OpenAPIPath path="/platform/monitoring.alauda.io/v1beta1/projects/{project}/metrics" />

<OpenAPIPath path="/platform/monitoring.alauda.io/v1beta1/projects/{project}/clusters/{cluster}/namespaces/{namespace}/metrics" />
<OpenAPIPath
path={[
'/platform/monitoring.alauda.io/v1beta1/clusters/{cluster}/metrics',
'/platform/monitoring.alauda.io/v1beta1/projects/{project}/metrics',
'/platform/monitoring.alauda.io/v1beta1/projects/{project}/clusters/{cluster}/namespaces/{namespace}/metrics',
]}
/>
12 changes: 7 additions & 5 deletions docs/en/apis/advanced_apis/monitor/variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@ sourceSHA: 3aa1c2708eed20fd5a33043f3ee378d1895625619b1af54b04d8f7a5225cf6ef

# Variables [monitoring.alauda.io/v1beta1]

<OpenAPIPath path="/platform/monitoring.alauda.io/v1beta1/clusters/{cluster}/variables" />

<OpenAPIPath path="/platform/monitoring.alauda.io/v1beta1/projects/{project}/variables" />

<OpenAPIPath path="/platform/monitoring.alauda.io/v1beta1/projects/{project}/clusters/{cluster}/namespaces/{namespace}/variables" />
<OpenAPIPath
path={[
'/platform/monitoring.alauda.io/v1beta1/clusters/{cluster}/variables',
'/platform/monitoring.alauda.io/v1beta1/projects/{project}/variables',
'/platform/monitoring.alauda.io/v1beta1/projects/{project}/clusters/{cluster}/namespaces/{namespace}/variables',
]}
/>
28 changes: 7 additions & 21 deletions docs/en/apis/kubernetes_apis/workload/pod.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,12 @@
<K8sAPI name="io.k8s.api.core.v1.Pod" pathPrefix="/kubernetes/{cluster}" />

<OpenAPIPath
path="/api/v1/namespaces/{namespace}/pods/{name}/eviction"
pathPrefix="/kubernetes/{cluster}"
/>

<OpenAPIPath
path="/api/v1/namespaces/{namespace}/pods/{name}/log"
pathPrefix="/kubernetes/{cluster}"
/>

<OpenAPIPath
path="/api/v1/namespaces/{namespace}/pods/{name}/exec"
pathPrefix="/kubernetes/{cluster}"
/>

<OpenAPIPath
path="/api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers"
pathPrefix="/kubernetes/{cluster}"
/>

<OpenAPIPath
path="/api/v1/namespaces/{namespace}/pods/{name}/attach"
path={[
'/api/v1/namespaces/{namespace}/pods/{name}/eviction',
'/api/v1/namespaces/{namespace}/pods/{name}/log',
'/api/v1/namespaces/{namespace}/pods/{name}/exec',
'/api/v1/namespaces/{namespace}/pods/{name}/ephemeralcontainers',
'/api/v1/namespaces/{namespace}/pods/{name}/attach',
]}
pathPrefix="/kubernetes/{cluster}"
/>
4 changes: 2 additions & 2 deletions docs/en/configure/backup/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Currently supports ClickHouse. Contact technical support.

For monitoring backup and restore, see [VictoriaMetrics Backup and Recovery](/observability/monitor/how_to/restore_victoriametrics.mdx).

## Application backup and restore
## Application backup and restore \{#application-backup-and-restore}

As a cluster administrator, you can back up and restore applications running on Alauda Container Platform by using Velero.

Expand All @@ -43,7 +43,7 @@ Application backup and restore consists of two components:
- **Alauda Container Platform Data Backup Essentials**: Provides the UI and is installed on the global cluster.
- **Alauda Container Platform Data Backup for Velero**: Provides Velero and is installed on workload clusters.

### Application installation
### Application installation \{#application-installation}

To enable application backup and restore:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ weight: 10

## Configuration Steps

### Deploy AWS Load Balancer Controller
### Deploy AWS Load Balancer Controller \{#deploy-aws-load-balancer-controller}

**Note**: For detailed information on deploying AWS Load Balancer Controller, see [official documentation](https://docs.aws.amazon.com/zh_cn/eks/latest/userguide/aws-load-balancer-controller.html).

Expand Down Expand Up @@ -126,7 +126,7 @@ You can create ingress and LoadBalancer services simultaneously or choose one ba

## Related Operations

### Test AWS CLI and eksctl Installation
### Test AWS CLI and eksctl Installation \{#test-aws-cli-and-eksctl-installation}

- Execute the following command. If it returns a cluster list, AWS CLI is correctly installed:

Expand All @@ -140,7 +140,7 @@ You can create ingress and LoadBalancer services simultaneously or choose one ba
eksctl get clusters
```

### Get ACCOUNT_ID
### Get ACCOUNT_ID \{#get-account_id}

Execute `aws sts get-caller-identity` to get **ACCOUNT_ID**. The `651168850570` in the response is the **ACCOUNT_ID**:

Expand All @@ -150,7 +150,7 @@ Execute `aws sts get-caller-identity` to get **ACCOUNT_ID**. The `651168850570`
}
```

### Kubeconfig Configuration File
### Kubeconfig Configuration File \{#kubeconfig-configuration-file}

1. Execute the following command to update the Kubeconfig file for the specified region:

Expand All @@ -164,7 +164,7 @@ Execute `aws sts get-caller-identity` to get **ACCOUNT_ID**. The `651168850570`
kubectl get svc -n cpaas-system
```

### Add Tags to Subnets
### Add Tags to Subnets \{#add-tags-to-subnets}

1. Execute the following command to get cluster subnets:

Expand All @@ -191,7 +191,7 @@ Execute `aws sts get-caller-identity` to get **ACCOUNT_ID**. The `651168850570`
aws ec2 create-tags --resources <subnet-id> --tags Key=kubernetes.io/cluster/<CLUSTER_NAME>,Value="shared"
```

### Create Certificate
### Create Certificate \{#create-certificate}

When using HTTPS protocol, save HTTPS certificate credentials as a Secret (TLS type) in advance.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you have created an AKS cluster, [import the Azure AKS cluster](/configure/cl

## Configuration Steps

### Deploy Ingress Controller
### Deploy Ingress Controller \{#deploy-ingress-controller}

AKS uses **container network mode** and leverages **Nginx Ingress Controller** to manage load balancers, while providing external access addresses for virtual IP addresses (VIPs) in the container internal network through **LoadBalancer** type **Services**.

Expand Down Expand Up @@ -56,7 +56,7 @@ You can create ingress and LoadBalancer services simultaneously or choose one ba

## Related Operations

### Create Certificate
### Create Certificate \{#create-certificate}

When using HTTPS protocol, save HTTPS certificate credentials as a Secret (TLS type) in advance.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ You can create ingress and LoadBalancer services simultaneously or choose one ba

3. View information about corresponding Ingress resources in the list.

### Create Certificate
### Create Certificate \{#create-certificate}

When using HTTPS protocol, save HTTPS certificate credentials as a Secret (TLS type) in advance.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ There are two methods to create ingress. **Method 1: Manual Ingress Class Select

## Related Operations

### Create Certificate
### Create Certificate \{#create-certificate}

When using HTTPS protocol, save HTTPS certificate credentials as a Secret (TLS type) in advance.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Platform integration with AWS EKS and storage initialization configuration.
## Related Operations
### Configure Available Storage Class Parameters
### Configure Available Storage Class Parameters \{#configure-available-storage-class-parameters}
* EFS File Storage Available Parameters
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The default azurefile file storage class may not support permission modification

## Related Information

### Default Storage Class Description
### Default Storage Class Description \{#default-storage-class-description}

| Storage Class Name | Storage Class Type | Description |
|---|---|---|
Expand All @@ -43,7 +43,7 @@ The default azurefile file storage class may not support permission modification
| managed-csi-premium | Block Storage | Creates managed disks using Azure premium locally redundant storage (LRS). |
| managed-premium | Block Storage | Creates managed disks using Azure premium storage. |

### Available Storage Class Parameters
### Available Storage Class Parameters \{#available-storage-class-parameters}

* For block storage optional parameters and meanings, see [Create and use volumes with Azure disks in Azure Kubernetes Service (AKS)](https://learn.microsoft.com/zh-cn/azure/aks/azure-csi-disk-storage-provision).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Platform integration with Google GKE and storage initialization configuration.

* Default file storage creation and deletion operations take considerable time. If it remains in creating status for a long time, please be patient.

## Prerequisites
## Prerequisites \{#prerequisites}

* When creating clusters, on the Google Cloud Platform **Cluster > Features** page under the **Other** section, check **Enable Compute Engine Persistent Disk CSI Driver** and **Enable Filestore CSI Driver** options.

Expand All @@ -38,7 +38,7 @@ Platform integration with Google GKE and storage initialization configuration.

## Related Information

### Default Storage Class Description
### Default Storage Class Description \{#default-storage-class-description}

| Storage Class Name | Storage Class Type | Description |
|---|---|---|
Expand All @@ -49,7 +49,7 @@ Platform integration with Google GKE and storage initialization configuration.
| enterprise-rwx | File Storage | Uses [Enterprise Filestore tier](https://cloud.google.com/filestore/docs/service-tiers?hl=zh-cn#enterprise_tier). |
| enterprise-multishare-rwx | File Storage | Uses [Enterprise Filestore tier](https://cloud.google.com/filestore/docs/service-tiers?hl=zh-cn#enterprise_tier). See [Filestore multishares for Google Kubernetes Engine](https://cloud.google.com/filestore/docs/multishares?hl=zh-cn). |

### Available Storage Class Parameters
### Available Storage Class Parameters \{#available-storage-class-parameters}

* For block storage optional parameters and meanings, see [Storage options](https://cloud.google.com/compute/docs/disks?hl=zh-cn#disk-types).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Cluster PVC quantity has limits, and account storage capacity has quotas. You ca

3. Select the **Project Assignment** method as needed and click **Update** to assign **csi-nas** or **csi-disk** storage classes to projects.

## Default Storage Class Description
## Default Storage Class Description \{#default-storage-class-description}

| Storage Class Name | Storage Class Type | Description |
|---|---|---|
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Obtain the configuration required to connect to the import cluster so that the p

## Get cluster information

### Get cluster token <span id="fetchtoken"></span>
### Get cluster token \{#fetchtoken}

1. Run the following commands:

Expand Down
2 changes: 1 addition & 1 deletion docs/en/configure/clusters/managed/import/alibaba-ack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ For product information about ACK managed clusters (Managed Kubernetes) or Aliba

## Prerequisites

* The Kubernetes version and parameters on the cluster meet the [component version and parameter requirements for importing standard Kubernetes clusters](/configure/clusters/overview.mdx#version-compatibility).
* The Kubernetes version and parameters on the cluster meet the [component version and parameter requirements for importing standard Kubernetes clusters](/overview/kubernetes-support-matrix.mdx#version-support-matrix).
Comment thread
JounQin marked this conversation as resolved.

## Get Image Registry Address

Expand Down
2 changes: 1 addition & 1 deletion docs/en/configure/clusters/managed/import/aws-eks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Connect an existing Amazon EKS (Elastic Kubernetes Service) cluster to the platf

## Prerequisites

* The cluster's Kubernetes version and settings meet the requirements in [Version compatibility for importing standard Kubernetes clusters](/configure/clusters/overview.mdx#version-compatibility).
* The cluster's Kubernetes version and settings meet the requirements in [Version compatibility for importing standard Kubernetes clusters](/overview/kubernetes-support-matrix.mdx#version-support-matrix).
Comment thread
JounQin marked this conversation as resolved.

* The image registry must support HTTPS and provide a valid TLS certificate issued by a public CA.

Expand Down
4 changes: 2 additions & 2 deletions docs/en/configure/clusters/managed/import/azure-aks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Import an existing Azure AKS cluster into the platform for unified management.

## Prerequisites

* The Kubernetes version and parameters on the cluster must meet the [Standard Kubernetes Cluster Component Version and Parameter Requirements](/configure/clusters/overview.mdx#version-compatibility).
* The Kubernetes version and parameters on the cluster must meet the [Standard Kubernetes Cluster Component Version and Parameter Requirements](/overview/kubernetes-support-matrix.mdx#version-support-matrix).
Comment thread
JounQin marked this conversation as resolved.

:::tip

Expand Down Expand Up @@ -71,7 +71,7 @@ After importing the cluster, if you need to use Ingress (inbound rules) and stor

## Frequently Asked Questions

### How to configure AKS node external IP security group rules
### How to configure AKS node external IP security group rules \{#how-to-configure-aks-node-external-ip-security-group-rules}

Nodes only have internal IPs by default. The external IP is configured on a frontend load balancer (LB), which is used for outbound traffic by default. This LB is controlled by the AKS principal. Direct manual modification of this configuration may cause issues. You can allow traffic through **Kubernetes** > **Properties** > **Infrastructure Resource Group** > **Network Security Group** > **Add Outbound/Inbound All Rules**.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/configure/clusters/managed/import/gcp-gke.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The platform supports importing Google GKE clusters.

## Prerequisites

* The Kubernetes version and components on the cluster meet the [version requirements for importing public cloud clusters](/configure/clusters/overview.mdx#version-cloud).
* The Kubernetes version and components on the cluster meet the [version requirements for importing public cloud clusters](/overview/kubernetes-support-matrix.mdx#version-support-matrix).
Comment thread
JounQin marked this conversation as resolved.

* Ensure the cluster type is a standard cluster and the account has permissions to maintain the control plane. Autopilot clusters are not currently supported.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/configure/clusters/managed/import/huawei-cce.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Import an existing CCE (Cloud Container Engine) cluster (public cloud) into the

## Prerequisites

* The Kubernetes version and parameters on the cluster meet the [Standard Kubernetes Cluster Component Version and Parameter Requirements](/configure/clusters/overview.mdx#version-compatibility).
* The Kubernetes version and parameters on the cluster meet the [Standard Kubernetes Cluster Component Version and Parameter Requirements](/overview/kubernetes-support-matrix.mdx#version-support-matrix).

* Ensure the cluster type is Huawei Cloud CCE cluster and the account has permissions to maintain the control plane. Turbo clusters are not currently supported.

Expand Down
Loading