📚 Sync docs from alaudadevops/connectors-operator on 4d1799e9757a47e73dda899b084744a83cf6298b

Source: sync docs from connectors (#143)
Author: chengjingtao
Ref: refs/heads/release-1.0
Commit: 4d1799e9757a47e73dda899b084744a83cf6298b

This commit automatically syncs documentation changes from the source-docs repository.

🔗 View source commit: AlaudaDevops/connectors-operator@4d1799e
🤖 Synced on 2025-08-15 10:27:11 UTC

Author: chengjingtao

.github/SYNC_INFO.md

@@ -1,10 +1,10 @@
 # Documentation Sync Information
 
-- **Last synced**: 2025-07-18 04:09:44 UTC
+- **Last synced**: 2025-08-15 10:27:11 UTC
 - **Source repository**: alaudadevops/connectors-operator
-- **Source commit**: [e0617bcedf319b0b4c93f0c5bffa01a6a3b925f9](https://github.com/alaudadevops/connectors-operator/commit/e0617bcedf319b0b4c93f0c5bffa01a6a3b925f9)
-- **Triggered by**: danielfbm
-- **Workflow run**: [#9](https://github.com/alaudadevops/connectors-operator/actions/runs/16361950693)
+- **Source commit**: [4d1799e9757a47e73dda899b084744a83cf6298b](https://github.com/alaudadevops/connectors-operator/commit/4d1799e9757a47e73dda899b084744a83cf6298b)
+- **Triggered by**: chengjingtao
+- **Workflow run**: [#14](https://github.com/alaudadevops/connectors-operator/actions/runs/16988133077)
 
 ## Files synced:
 - docs/

.yarn/releases/yarn-4.6.0.cjs

@@ -29,101 +29,101 @@ 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. Authorize the Namespace to use the connector
 
-```shell
-cat <<EOF | kubectl apply -f -
-apiVersion: rbac.authorization.k8s.io/v1
-kind: RoleBinding
-metadata:
-  name: connectors-reader-binding
-  namespace: connectors-git-demo
-subjects:
-  - kind: Group
-    name: system:serviceaccounts:connectors-git-demo
-    apiGroup: rbac.authorization.k8s.io
-roleRef:
-  kind: ClusterRole
-  name: connectors-connector-viewer-role
-  apiGroup: rbac.authorization.k8s.io
-EOF
-```
+    ```shell
+    cat <<EOF | kubectl apply -f -
+    apiVersion: rbac.authorization.k8s.io/v1
+    kind: RoleBinding
+    metadata:
+      name: connectors-reader-binding
+      namespace: connectors-git-demo
+    subjects:
+      - kind: Group
+        name: system:serviceaccounts:connectors-git-demo
+        apiGroup: rbac.authorization.k8s.io
+    roleRef:
+      kind: ClusterRole
+      name: connectors-connector-viewer-role
+      apiGroup: rbac.authorization.k8s.io
+    EOF
+    ```
 
 4. 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
+    ```
 
 5. 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:
 

.yarn/releases/yarn-4.9.2.cjs

@@ -2,7 +2,6 @@
 weight: 10
 sourceSHA: f004f8b0f9bbecaa15de28d21a8a367a113c07b6af44a6de5e86fc96d5f13741
 ---
-
 # Introduction
 
 ## Connectors Git

docs/en/connectors-git/how_to/use-git-connector-in-clone-job.md

@@ -3,7 +3,6 @@ weight: 70
 i18n:
   title:
     en: Troubleshooting
-sourceSHA: 8f04f4df58848dd0c8fded6b7971a0c1a25b7ae586810b24fad45cf7798c8fa2
 title: Troubleshooting
 ---
 

docs/en/connectors-git/intro.mdx

@@ -107,8 +107,7 @@ spec:
 
 Health check configuration:
 
-- `repository`: Specifies the image repository used for health checks.
-  - Example: `library/ubuntu`.
+`repository`: Specifies the image repository used for health checks, example: `library/ubuntu`.
 
 ```yaml
 apiVersion: connectors.alauda.io/v1alpha1
@@ -145,7 +144,7 @@ After creating the Connector, the system will perform the following operations:
 1. Perform health checks using the image repository specified by `spec.auth.params[name=repository]`.
 2. Store the check results in the `status.conditions[type=AuthReady]` field.
 
-### Configuration Information {#configuration}
+### Configuration Information \{#configuration}
 
 `OCI ConnectorClass` provides the following configurations:
 
@@ -191,7 +190,7 @@ insecure-entitlements = [ "network.host", "security.insecure" ]
 
 You can mount this configuration information into Pods using connectors-csi, enabling keyless (Secretless) image pushing or pulling.
 
-### Proxy Information {#proxy}
+### Proxy Information \{#proxy}
 
 After creating the Connector, the system will:
 

docs/en/connectors-git/trouble_shooting/index.mdx

@@ -122,6 +122,8 @@ Pass the following parameters to TaskRun:
 - Specify the `buildkitd-config` workspace as the `buildkitd` configuration of the OCI connector, thereby mounting `buildkitd.toml`.
 - Adjust the target image address for the push to the proxy address.
 
+{/* lint ignore code-block-split-list */}
+
 ```shell
 kubectl create -f - <<EOF
 apiVersion: tekton.dev/v1beta1

docs/en/connectors-oci/how_to/oci_connectorclass.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
 

docs/en/connectors-oci/how_to/using_oci_connector_in_tekton_pipeline.mdx

@@ -115,7 +115,7 @@ spec:
       value: "org/repo.git"
 ```
 
-## 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`.