📚 Sync docs from alaudadevops/connectors-operator on d4e3ec4657ec05dae428d89f513d54c1e774e3b1

chengjingtao · chengjingtao · commit b8bf3a397cb1 · 2025-08-15T11:02:14.000Z
Source: docs: sync main docs from connectors 1.0 (#145) Author: chengjingtao Ref: refs/heads/main Commit: d4e3ec4657ec05dae428d89f513d54c1e774e3b1 This commit automatically syncs documentation changes from the source-docs repository. 🔗 View source commit: AlaudaDevops/connectors-operator@d4e3ec4 🤖 Synced on 2025-08-15 11:02:14 UTC
diff --git a/.github/SYNC_INFO.md b/.github/SYNC_INFO.md
@@ -1,10 +1,10 @@
 # Documentation Sync Information
 
-- **Last synced**: 2025-08-07 01:35:38 UTC
+- **Last synced**: 2025-08-15 11:02:14 UTC
 - **Source repository**: alaudadevops/connectors-operator
-- **Source commit**: [baffe3295c099d05acc98e6ec3dc44f4303df345](https://github.com/alaudadevops/connectors-operator/commit/baffe3295c099d05acc98e6ec3dc44f4303df345)
+- **Source commit**: [d4e3ec4657ec05dae428d89f513d54c1e774e3b1](https://github.com/alaudadevops/connectors-operator/commit/d4e3ec4657ec05dae428d89f513d54c1e774e3b1)
 - **Triggered by**: chengjingtao
-- **Workflow run**: [#10](https://github.com/alaudadevops/connectors-operator/actions/runs/16792874228)
+- **Workflow run**: [#16](https://github.com/alaudadevops/connectors-operator/actions/runs/16988648854)
 
 ## Files synced:
 - docs/
diff --git a/.yarn/releases/yarn-4.6.0.cjs b/.yarn/releases/yarn-4.6.0.cjs
diff --git a/.yarn/releases/yarn-4.9.2.cjs b/.yarn/releases/yarn-4.9.2.cjs
diff --git a/docs/en/connectors-git/how_to/use-git-connector-in-clone-job.md b/docs/en/connectors-git/how_to/use-git-connector-in-clone-job.md
@@ -29,81 +29,81 @@ Follow these steps to use the Git Connector to complete code cloning:
 
 1. Create a Namespace
 
-```shell
-kubectl create ns connectors-git-demo
-```
+    ```shell
+    kubectl create ns connectors-git-demo
+    ```
 
 2. Create Git Connector and its credentials
 
-```shell
-cat <<EOF | kubectl apply -f -
-kind: Secret
-apiVersion: v1
-metadata:
-  name: test-secret
-  namespace: connectors-git-demo
-type: kubernetes.io/basic-auth
-stringData:
-  username: username # Replace with your Git Server username
-  password: password # Replace with your Git Server password
----
-apiVersion: connectors.alauda.io/v1alpha1
-kind: Connector
-metadata:
-  name: test-connector
-  namespace: connectors-git-demo
-spec:
-  connectorClassName: git
-  address: https://github.com # Replace with your Git Server address
-  auth:
-    name: basicAuth
-    secretRef:
+    ```shell
+    cat <<EOF | kubectl apply -f -
+    kind: Secret
+    apiVersion: v1
+    metadata:
       name: test-secret
-    params:
-    - name: repository
-      value: AlaudaDevops/connectors-git.git # Replace with the path to the repository accessible by the current credentials
-EOF
-```
+      namespace: connectors-git-demo
+    type: kubernetes.io/basic-auth
+    stringData:
+      username: username # Replace with your Git Server username
+      password: password # Replace with your Git Server password
+    ---
+    apiVersion: connectors.alauda.io/v1alpha1
+    kind: Connector
+    metadata:
+      name: test-connector
+      namespace: connectors-git-demo
+    spec:
+      connectorClassName: git
+      address: https://github.com # Replace with your Git Server address
+      auth:
+        name: basicAuth
+        secretRef:
+          name: test-secret
+        params:
+        - name: repository
+          value: AlaudaDevops/connectors-git.git # Replace with the path to the repository accessible by the current credentials
+    EOF
+    ```
 
 3. Create a clone job using the connector
 
-```shell
-cat <<EOF | kubectl apply -f -
-apiVersion: batch/v1
-kind: Job
-metadata:
-  name: git-clone
-  namespace: connectors-git-demo
-spec:
-  template:
+    ```shell
+    cat <<EOF | kubectl apply -f -
+    apiVersion: batch/v1
+    kind: Job
+    metadata:
+      name: git-clone
+      namespace: connectors-git-demo
     spec:
-      restartPolicy: Never
-      containers:
-      - name: git
-        image: bitnami/git:2.47.1
-        imagePullPolicy: IfNotPresent
-        command:
-        - "git"
-        args: [ "clone", "--progress", "https://github.com/AlaudaDevops/connectors-git.git", "/tmp/demo" ] # Change to your repository address
-        volumeMounts:
-        - name: gitconfig
-          mountPath: /root/
-      volumes:
-      - name: gitconfig
-        csi:
-          readOnly: true
-          driver: connectors-csi
-          volumeAttributes:
-            connector.name: "test-connector"
-            configuration.names: "gitconfig"
-EOF
-```
+      template:
+        spec:
+          restartPolicy: Never
+          containers:
+          - name: git
+            image: bitnami/git:2.47.1
+            imagePullPolicy: IfNotPresent
+            command:
+            - "git"
+            args: [ "clone", "--progress", "https://github.com/AlaudaDevops/connectors-git.git", "/tmp/demo" ] # Change to your repository address
+            volumeMounts:
+            - name: gitconfig
+              mountPath: /root/
+          volumes:
+          - name: gitconfig
+            csi:
+              readOnly: true
+              driver: connectors-csi
+              volumeAttributes:
+                connector.name: "test-connector"
+                configuration.names: "gitconfig"
+    EOF
+    ```
 
 4. View the clone job execution result
 
-```shell
-kubectl logs -f job/git-clone -n connectors-git-demo
-```
+    ```shell
+    kubectl logs -f job/git-clone -n connectors-git-demo
+    ```
 
 Parameter descriptions are as follows:
 
diff --git a/docs/en/connectors-oci/concepts/oci_connectorclass.mdx b/docs/en/connectors-oci/concepts/oci_connectorclass.mdx
@@ -149,7 +149,7 @@ status:
   # . . .
   proxy:
     httpAddress:
-      url: http://dockerhub-demo.default.svc.cluster.local/namespaces/default/connectors/dockerhub-demo
+      url: http://c-dockerhub-demo.default.svc.cluster.local/namespaces/oci-connector-demo/connectors/oci-connector
 ```
 
 ### Configuration
diff --git a/docs/en/connectors-oci/how_to/using_oci_connector_in_k8s.mdx b/docs/en/connectors-oci/how_to/using_oci_connector_in_k8s.mdx
@@ -29,7 +29,7 @@ Next, we will elaborate on the specific meaning of each item.
 1. Modifying the target image address to the proxied image repository address
 
 Example:
-harbar.example.com/test/abc:v1 → c-harbor-connector.default.svc.local/test/abc:v1
+harbar.example.com/test/abc:v1 → c-harbor-connector.default.svc.local/namespaces/oci-connector-ns/connectors/oci-connector-name/test/abc:v1
 
 2. Configuring the authentication information required to access the proxy
 
diff --git a/docs/en/connectors-oci/how_to/using_oci_connector_in_k8s_job.mdx b/docs/en/connectors-oci/how_to/using_oci_connector_in_k8s_job.mdx
@@ -14,7 +14,7 @@ This article will guide you on how to use the OCI Connector to build images with
 When using the OCI Connector within a Kubernetes Job, the following key points should be noted:
 
 - Change the address of the target image being built to the connector's proxy address. [What is the Connector Proxy Address](../concepts/oci_connectorclass.mdx#proxy)
-  - For example: `harbor.example.cn/test/abc:v1` -> `harbor.default.cluster.local/namespaces/<connector-ns>/connectors/<connector-name>/test/abc:v1`
+  - For example: harbor.example.cn/test/abc:v1 -> harbor.default.cluster.local/namespaces/oci-connector-ns/connectors/oci-connector-name/test/abc:v1
 - Mount the configuration provided by the Connector.
 - Configure `insecure registry` for the client tools.
 
diff --git a/docs/en/connectors-oci/how_to/using_oci_connector_in_tekton_pipeline.mdx b/docs/en/connectors-oci/how_to/using_oci_connector_in_tekton_pipeline.mdx
@@ -14,7 +14,7 @@ This article will teach you how to use the OCI Connector in the `Tekton Pipeline
 When using the OCI Connector in Tekton Pipeline, there are several key points to note:
 
 - The address of the target image to be built is changed to the connector's proxy address.
-  - For example: `harbor.example.cn/test/abc:v1` -> `harbor.default.cluster.local/namespaces/<connector-ns>/connectors/<connector-name>/test/abc:v1`
+  - For example, harbor.example.cn/test/abc:v1 -> harbor.default.cluster.local/namespaces/oci-connector-ns/connectors/oci-connector-name/test/abc:v1
 - Mount the configuration provided by the Connector.
 - Configure `insecure registry` for the client tools.
 
diff --git a/docs/en/connectors/architecture/index.mdx b/docs/en/connectors/architecture/index.mdx
@@ -31,7 +31,21 @@ For example, a `Harbor ConnectorClass` can be defined to support integration wit
 
 ## Connectors Proxy
 
-TODO:
+`ConnectorsProxy` is a core component of the `Connectors` system that provides a secure, secretless way to access integrated tools within a Kubernetes cluster. It acts as a proxy server that handles authentication and routing of requests to the actual tool endpoints.
+
+`ConnectorsProxy` enables clients to access tool resources without needing to handle authentication credentials directly. This significantly improves security by:
+
+- Eliminates the need to distribute tool credentials directly to clients by using short-lived tokens issued by ServiceAccount.
+- Preventing credential exposure in logs or environment variables
+- Centralizing credential management
+
+It supports various protocols and can handle different types of tool integrations:
+
+- HTTP/HTTPS protocols for REST APIs
+- Git protocol witch HTTP Basic Auth for code repositories server (e.g. GitHub, GitLab)
+- OCI protocol witch Bearar Token Authorization for OCI registries (e.g. Harbor, Docker Registry)
+
+More information: [Connectors Proxy](../concepts/connectors_proxy.mdx)
 
 ## Connectors API
 
diff --git a/docs/en/connectors/concepts/connector.mdx b/docs/en/connectors/concepts/connector.mdx
@@ -118,7 +118,7 @@ spec:
 
 Note that once the ConnectorClass specifies authentication detection params, parameters in connector must be provided, even if the Connector is created without specifying secret information, `spec.auth.params` must be passed.
 
-## Proxy Address {#connector_proxy}
+## Proxy Address \{#connector_proxy}
 
 If the `Connector` points to a `ConnectorClass` that has configured [proxy capability](./connectorclass.mdx#proxy), the system will allocate a proxy address for each `Connector`. 
 
diff --git a/docs/en/connectors/concepts/connectorclass.mdx b/docs/en/connectors/concepts/connectorclass.mdx
@@ -406,7 +406,7 @@ For more Rego language details, refer to:
 
 - [Rego Policy Language](https://www.openpolicyagent.org/docs/latest/policy-language)
 
-## ConnectorClass API {#connectorclass_api}
+## ConnectorClass API \{#connectorclass_api}
 
 Provides a RESTful API for the current ConnectorClass, allowing clients to easily access resources within the tools when using Connectors.
 
@@ -558,7 +558,7 @@ spec:
 
 - [connectors csi driver](./connectors_csi.mdx)
 
-## Metadata Information for Readability Display {#metadata}
+## Metadata Information for Readability Display \{#metadata}
 
 `ConnectorClass` is a standard k8s resource that can be tagged with custom information using `labels` and `annotations`.
 
@@ -589,7 +589,7 @@ metadata:
     connectors.cpaas.io/docs-link: "/alauda-devops-connectors/concepts/connectorclass/git"
 ```
 
-## ConnectorClass Proxy {#connectorclass_proxy}
+## ConnectorClass Proxy \{#connectorclass_proxy}
 
 The ConnectorClass Proxy is used to configure the proxy address for the ConnectorClass. 
 
@@ -684,7 +684,7 @@ Updates to the ConnectorClass may affect existing Connectors. If there are incom
 
 It is recommended to confirm the scope of impact when updating the ConnectorClass, or if necessary, create a new ConnectorClass.
 
-## More Examples {#examples}
+## More Examples \{#examples}
 
 - ConnectorClass supporting `basic-auth` authentication type
 
diff --git a/docs/en/connectors/concepts/connectors_proxy.mdx b/docs/en/connectors/concepts/connectors_proxy.mdx
@@ -13,9 +13,9 @@ ConnectorsProxy is a core component of the Connectors system that provides a sec
 
 ### Secretless Access
 
-ConnectorsProxy enables clients to access tool resources without needing to handle authentication credentials directly. This significantly improves security by:
+`ConnectorsProxy` enables clients to access tool resources without needing to handle authentication credentials directly. This significantly improves security by:
 
-- Eliminating the need to distribute credentials to workloads
+- Eliminates the need to distribute tool credentials directly to clients by using short-lived tokens issued by ServiceAccount.
 - Preventing credential exposure in logs or environment variables
 - Centralizing credential management
 
diff --git a/docs/en/connectors/intro.mdx b/docs/en/connectors/intro.mdx
@@ -48,7 +48,7 @@ For example:
 
 More readings:
 
-- [How to use the Git Connector to complete Git clone without storing credentials on the client](https://github.com/AlaudaDevops/connectors-git/blob/main/docs/use-git-connector-in-clone-job.md)
+- [How to use the Git Connector to complete Git clone without storing credentials on the client](../connectors-git/how_to/use-git-connector-in-clone-job.mdx)
 - [Connectors Proxy](./concepts/connectors_proxy.mdx)
 - [Connectors CSI Driver](./concepts/connectors_csi.mdx)
 
diff --git a/docs/en/install.mdx b/docs/en/install.mdx
@@ -41,30 +41,30 @@ First, install the Connectors Operator which manages the lifecycle of all other
 
 2. Apply the operator subscription YAML:
 
-  ```bash
-  cat <<EOF | kubectl apply -f -
-  apiVersion: operators.coreos.com/v1alpha1
-  kind: Subscription
-  metadata:
-    annotations:
-      cpaas.io/target-namespaces: ""
-    labels:
-      catalog: platform
-    name: connectors-operator
-    namespace: connectors-operator
-  spec:
-    channel: alpha
-    installPlanApproval: Manual
-    name: connectors-operator
-    source: platform
-    sourceNamespace: cpaas-system
-  EOF
-
-  kubectl wait --for=condition=InstallPlanPending subscription.operators.coreos.com/connectors-operator -n connectors-operator
-
-  installplanname=$(kubectl get subscription.operators.coreos.com -n connectors-operator connectors-operator -ojsonpath='{.status.installPlanRef.name}')
-  kubectl patch installplan -n connectors-operator ${installplanname} --type='merge' -p='{"spec":{"approved":true}}'
-  ```
+    ```bash
+    cat <<EOF | kubectl apply -f -
+    apiVersion: operators.coreos.com/v1alpha1
+    kind: Subscription
+    metadata:
+      annotations:
+        cpaas.io/target-namespaces: ""
+      labels:
+        catalog: platform
+      name: connectors-operator
+      namespace: connectors-operator
+    spec:
+      channel: alpha
+      installPlanApproval: Manual
+      name: connectors-operator
+      source: platform
+      sourceNamespace: cpaas-system
+    EOF
+
+    kubectl wait --for=condition=InstallPlanPending subscription.operators.coreos.com/connectors-operator -n connectors-operator
+
+    installplanname=$(kubectl get subscription.operators.coreos.com -n connectors-operator connectors-operator -ojsonpath='{.status.installPlanRef.name}')
+    kubectl patch installplan -n connectors-operator ${installplanname} --type='merge' -p='{"spec":{"approved":true}}'
+    ```
 
 3. Verify the operator is running:
 
@@ -307,7 +307,7 @@ To uninstall the Connectors system, remove components in the reverse order of in
 
 4. Delete the CRDs:
 
-  **Warning: This will delete all user data about connectors**
+   **Warning: This will delete all user data about connectors**
 
    ```bash
    kubectl delete crd connectors.connectors.alauda.io
diff --git a/docs/en/overview/release_notes.mdx b/docs/en/overview/release_notes.mdx
@@ -36,15 +36,15 @@ The following table shows the compatibility and support matrix between the Alaud
 
 The OCI connector image address format has been updated to provide better namespace isolation and resource management.
   
-  **Previous Format**: `c-connector.connector-ns.svc.cluster.local`
-  
-  **New Format**: `connector.connector-ns.svc.cluster.local/namespaces/<connector-ns>/connectors/<connector-name>`
-  
-  **Affected Scenarios**:
-  - **[Building Images Using OCI Connector in K8S Job](../connectors-oci/how_to/using_oci_connector_in_k8s_job.mdx)**: Image address changed from `c-harbor.default.svc.cluster.local/test/demo:v1` to `harbor.default.svc.cluster.local/namespaces/oci-connector-demo/connectors/oci-connector/test/demo:v1`
-  - **[Building Images Using OCI Connector in Tekton Pipeline](../connectors-oci/how_to/using_oci_connector_in_tekton_pipeline.mdx)**: Image address changed from `c-harbor.default.svc.cluster.local/test/demo:v1` to `harbor.default.svc.cluster.local/namespaces/oci-connector-demo/connectors/oci-connector/test/demo:v1`
-  
-  **Upgrade Instructions**: Existing workloads using OCI connectors need to update their image address format to adapt to the new naming convention.
+**Previous Format**: `c-connector.connector-ns.svc.cluster.local`
+
+**New Format**: `connector.connector-ns.svc.cluster.local/namespaces/<connector-ns>/connectors/<connector-name>`
+
+**Affected Scenarios**:
+- **[Building Images Using OCI Connector in K8S Job](../connectors-oci/how_to/using_oci_connector_in_k8s_job.mdx)**: Image address changed from `c-harbor.default.svc.cluster.local/test/demo:v1` to `harbor.default.svc.cluster.local/namespaces/oci-connector-demo/connectors/oci-connector/test/demo:v1`
+- **[Building Images Using OCI Connector in Tekton Pipeline](../connectors-oci/how_to/using_oci_connector_in_tekton_pipeline.mdx)**: Image address changed from `c-harbor.default.svc.cluster.local/test/demo:v1` to `harbor.default.svc.cluster.local/namespaces/oci-connector-demo/connectors/oci-connector/test/demo:v1`
+
+**Upgrade Instructions**: Existing workloads using OCI connectors need to update their image address format to adapt to the new naming convention.
 
 #### Services "c-xxx" already exist
 
diff --git a/package.json b/package.json
@@ -1,13 +1,14 @@
 {
   "devDependencies": {
-    "@alauda/doom": "^1.10.2",
-    "typescript": "^5.7.3"
+    "@alauda/doom": "^1.10.9",
+    "typescript": "^5.9.2"
   },
   "scripts": {
     "dev": "doom dev",
     "build": "doom build",
+    "lint": "doom lint",
     "serve": "doom serve",
     "translate": "doom translate"
   },
-  "packageManager": "yarn@4.6.0"
+  "packageManager": "yarn@4.9.2"
 }
diff --git a/yarn.lock b/yarn.lock
