Skip to content

Commit 5e3601b

Browse files
author
edge-katanomi-app2[bot]
committed
📚 Sync docs from alaudadevops/connectors-operator on ed61bf24fa37369c05f9c2c1105de73f13d291ec
Source: remove docker char in docs (#441) Author: edge-katanomi-app2[bot] Ref: refs/heads/main Commit: ed61bf24fa37369c05f9c2c1105de73f13d291ec This commit automatically syncs documentation changes from the source-docs repository. 🔗 View source commit: https://github.com/alaudadevops/connectors-operator/commit/ed61bf24fa37369c05f9c2c1105de73f13d291ec 🤖 Synced on 2025-12-12 13:54:23 UTC
1 parent d6151b9 commit 5e3601b

File tree

13 files changed

+23
-47
lines changed

13 files changed

+23
-47
lines changed

‎.github/SYNC_INFO.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Documentation Sync Information
22

3-
- **Last synced**: 2025-12-12 09:48:31 UTC
3+
- **Last synced**: 2025-12-12 13:54:23 UTC
44
- **Source repository**: alaudadevops/connectors-operator
5-
- **Source commit**: [6a7385533b855bbdd1a4d7b8e938382f3f48f71a](https://github.com/alaudadevops/connectors-operator/commit/6a7385533b855bbdd1a4d7b8e938382f3f48f71a)
6-
- **Triggered by**: chengjingtao
7-
- **Workflow run**: [#64](https://github.com/alaudadevops/connectors-operator/actions/runs/20162848513)
5+
- **Source commit**: [ed61bf24fa37369c05f9c2c1105de73f13d291ec](https://github.com/alaudadevops/connectors-operator/commit/ed61bf24fa37369c05f9c2c1105de73f13d291ec)
6+
- **Triggered by**: edge-katanomi-app2[bot]
7+
- **Workflow run**: [#66](https://github.com/alaudadevops/connectors-operator/actions/runs/20168921193)
88

99
## Files synced:
1010
- docs/

‎docs/en/connectors-harbor/concepts/harbor_connectorclass.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ Additionally, you need to mount the configuration files into the Pod and configu
158158

159159
The OCI Connector created based on the OCI Connector type provides the following configurations:
160160

161-
**config**: Configuration information required by Docker CLI.
161+
**config**: Configuration information required by OCI CLI like buildkit, buildah, etc.
162162

163163
- Provides the `config.json` configuration file.
164164
- Contains the authentication information required to access the proxy.

‎docs/en/connectors-harbor/how_to/using_harbor_connector_in_k8s_job.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ spec:
198198
configMap:
199199
name: dockerfile
200200
201-
# Mounting docker's config.json to the Pod
201+
# Mounting config.json to the Pod
202202
- name: docker-config
203203
csi:
204204
readOnly: true

‎docs/en/connectors-harbor/how_to/using_harbor_connector_in_workload.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ For more information on Connector resource permissions, see [Connector Scope Per
114114
115115
### Step 3: Create an Image Pull Secret
116116

117-
Create a Docker registry secret using the ServiceAccount token:
117+
Create a registry secret using the ServiceAccount token:
118118

119119
```bash
120120
kubectl create secret docker-registry harbor-connector-secret \
@@ -136,7 +136,7 @@ http://192.168.x.x:31567/namespaces/harbor-connector-demo/connectors/harbor
136136

137137
- The `docker-username` is set to "u" (a placeholder username)
138138
- The `docker-password` uses the Service Account token from the previous step
139-
- The `docker-email` can be any valid email address (used for Docker registry compatibility)
139+
- The `docker-email` can be any valid email address (used for CNCF Distribution Registry compatibility)
140140

141141
### Step 4: Patch ServiceAccount with Image Pull Secret
142142

‎docs/en/connectors-harbor/quick_start.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ Key parameters in the volume definition:
168168
- `"buildkitd"`: Generates BuildKit daemon config for insecure registry access
169169
- if not specified, will be mounted [default configurations](../connectors/concepts/connectors_csi.mdx#built-in-configurations)
170170
- `mountPath`: Specifies where the configuration file should be mounted in the container:
171-
- "/root/.docker" for Docker authentication configuration
171+
- "/root/.docker" for buildkit authentication configuration
172172

173173
### Step 4: Verify Operation
174174

‎docs/en/connectors-oci/concepts/oci_connectorclass.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ and mount the credential configuration files into the Pod and configure the prox
204204

205205
The OCI Connector created based on the OCI Connector type provides the following configurations:
206206

207-
**docker-config**: Configuration credentials required by Container Registry Client.
207+
**docker-config**: Configuration credentials required by OCI CLI like buildkit, buildah.
208208

209209
- Provides the `config.json` configuration file.
210210
- Contains the authentication information required to access the proxy.

‎docs/en/connectors-oci/how_to/using_oci_connector_in_workload.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ For more information on Connector resource permissions, see [Connector Scope Per
114114
115115
### Step 3: Create an Image Pull Secret
116116

117-
Create a Docker registry secret using the ServiceAccount token:
117+
Create a registry secret using the ServiceAccount token:
118118

119119
```bash
120120
kubectl create secret docker-registry oci-connector-secret \
@@ -136,7 +136,7 @@ http://192.168.x.x:31567/namespaces/oci-connector-demo/connectors/harbor
136136

137137
- The `docker-username` is set to "u" (a placeholder username)
138138
- The `docker-password` uses the Service Account token from the previous step
139-
- The `docker-email` can be any valid email address (used for Docker registry compatibility)
139+
- The `docker-email` can be any valid email address (used for CNCF Distribution Registry compatibility)
140140

141141
### Step 4: Patch ServiceAccount with Image Pull Secret
142142

‎docs/en/connectors-oci/intro.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ConnectorsOCI is a specialized connector component that facilitates secure and c
1616
ConnectorsOCI provides several key capabilities:
1717

1818
- Secure access to container registries (Docker Hub, Harbor, GitHub Container Registry, etc.)
19-
- Configuration generation for various container tools (Docker, BuildKit, etc.)
19+
- Configuration generation for various container tools (BuildKit, etc.)
2020
- Automatic credential injection for registry operations via CSI volumes
2121
- Proxy mechanism for registry authentication and access
2222

‎docs/en/connectors-oci/quick_start.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ This approach is particularly useful for:
2828
## Notes
2929

3030
- The OCI connector uses CSI driver integration to inject registry credentials securely.
31-
- Different container tools (Docker, Buildah, etc.) may require specific configuration for insecure registry access.
31+
- Different container tools (Buildah, etc.) may require specific configuration for insecure registry access.
3232
- Configuration files generated by the connector expire after 30 minutes.
3333

3434
## Prerequisites
@@ -188,7 +188,7 @@ Key parameters in the volume definition:
188188
- `"docker-config"`: Generates authentication config (config.json) needed for any registry operations
189189
- `"buildkitd"`: Generates BuildKit daemon config for insecure registry access
190190
- `mountPath`: Specifies where the configuration file should be mounted in the container:
191-
- "/root/.docker" for Docker authentication configuration
191+
- "/root/.docker" for OCI CLI like buildkit, buildah authentication configuration
192192
- "/etc/buildkit" for BuildKit configuration
193193

194194
### Step 4: Verify Operation

‎docs/en/connectors-oci/trouble_shooting/csi_driver_issues.mdx‎

Lines changed: 4 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ This guide provides detailed steps for diagnosing and resolving common issues wi
1717
| Volume mount failures | Incorrect CSI configuration, driver unavailable | Workload can't start |
1818
| Docker config not found | Wrong mount path, missing volumes | Image pull/push operations fail |
1919
| Authentication failures | Token issues, configuration errors | Registry access denied |
20-
| Insecure registry issues | Misconfigured Docker daemon | TLS/certificate errors |
2120

2221
## Checking CSI Volume Configuration
2322

@@ -38,7 +37,7 @@ volumes:
3837
3938
| Configuration Name | Description | Use Case |
4039
|-------------------|-------------|----------|
41-
| `docker-config` | Standard Docker client configuration | General container operations |
40+
| `docker-config` | Standard OCI client like buildkit, buildah authentication configuration | General container operations |
4241
| `buildkitd` | BuildKit daemon configuration | For BuildKit based operations |
4342

4443
**Common configuration issues**:
@@ -47,7 +46,7 @@ volumes:
4746
|-------|---------|------------|
4847
| Incorrect driver name | `MountVolume.SetUp failed` error | Set `driver` exactly to `connectors-csi` |
4948
| Connector not found | `could not get connector` error | Ensure connector exists in the same namespace |
50-
| Wrong configuration name | No Docker config generated | Set correct `configuration.names` value |
49+
| Wrong configuration name | No config generated | Set correct `configuration.names` value |
5150
| Namespace mismatch | Volume attachment fails | Make sure connector is in the same namespace as pod |
5251

5352
**How to verify**:
@@ -76,7 +75,7 @@ volumeMounts:
7675

7776
| Configuration | Recommended Mount Path | Description |
7877
|---------------|------------------------|-------------|
79-
| `docker-config` | `/root/.docker` or `$HOME/.docker` | Docker client configuration directory |
78+
| `docker-config` | `/root/.docker` or `$HOME/.docker` | OCI client like buildkit, buildah authentication configuration directory |
8079
| `buildkitd` | `/etc/buildkit` | BuildKit daemon configuration directory |
8180

8281

@@ -123,7 +122,7 @@ If configuration files are not found, check:
123122
4. Connector is Ready
124123
5. Mount path matches container user's expected path
125124

126-
## Examining Docker Configuration Content
125+
## Examining OCI Client Configuration Content
127126

128127
### docker-config
129128

@@ -161,29 +160,6 @@ insecure-entitlements = [ "network.host", "security.insecure" ]
161160
http = true
162161
```
163162

164-
165-
### Insecure Registry Issues
166-
167-
**Symptoms**:
168-
- `server certificate verification failed` errors
169-
- TLS handshake failures
170-
171-
**Troubleshooting**:
172-
1. Verify insecure registry settings are correctly configured:
173-
```bash
174-
kubectl exec <pod-name> -n <namespace> -- cat /etc/docker/daemon.json
175-
```
176-
177-
2. Check if the container runtime is using the mounted configuration:
178-
```bash
179-
kubectl exec <pod-name> -n <namespace> -- docker info | grep -A 5 "Insecure Registries"
180-
```
181-
182-
3. For containerd, verify proxy address is properly configured:
183-
```bash
184-
kubectl exec -it <node-name> -n <namespace> -- cat /etc/containerd/config.toml | grep -A 10 registry
185-
```
186-
187163
## Advanced Troubleshooting
188164

189165
### CSI Driver Logs

0 commit comments

Comments
 (0)