Skip to content

Commit 4e9be1b

Browse files
committed
📚 Sync docs from alaudadevops/connectors-operator on 226b27d8c68af51e2f70180f78e0451cc6d96f6d
Source: docs: remove docs make script and fix crd refs in crds/connectors (#206) Author: edge-katanomi-app2[bot] Ref: refs/heads/release-1.2 Commit: 226b27d8c68af51e2f70180f78e0451cc6d96f6d This commit automatically syncs documentation changes from the source-docs repository. 🔗 View source commit: AlaudaDevops/connectors-operator@226b27d 🤖 Synced on 2025-09-15 06:02:26 UTC
1 parent 295f1f6 commit 4e9be1b

File tree

14 files changed

+1420
-2266
lines changed

14 files changed

+1420
-2266
lines changed

‎.github/SYNC_INFO.md‎

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

3-
- **Last synced**: 2025-08-22 02:43:08 UTC
3+
- **Last synced**: 2025-09-15 06:02:26 UTC
44
- **Source repository**: alaudadevops/connectors-operator
5-
- **Source commit**: [6b5180ec3e4d2c8602ed51a59f3f18e51b6674d5](https://github.com/alaudadevops/connectors-operator/commit/6b5180ec3e4d2c8602ed51a59f3f18e51b6674d5)
5+
- **Source commit**: [226b27d8c68af51e2f70180f78e0451cc6d96f6d](https://github.com/alaudadevops/connectors-operator/commit/226b27d8c68af51e2f70180f78e0451cc6d96f6d)
66
- **Triggered by**: chengjingtao
7-
- **Workflow run**: [#19](https://github.com/alaudadevops/connectors-operator/actions/runs/17144573337)
7+
- **Workflow run**: [#33](https://github.com/alaudadevops/connectors-operator/actions/runs/17723599227)
88

99
## Files synced:
1010
- docs/
Lines changed: 358 additions & 358 deletions
Large diffs are not rendered by default.

‎docs/en/connectors-k8s/concepts/k8s_connectorclass.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ status:
154154
url: http://c-k8s-connector.default.svc.cluster.local
155155
```
156156

157-
#### kubeconfig configuration file {#kubeconfig-configuration-file}
157+
#### kubeconfig configuration file \{#kubeconfig-configuration-file}
158158

159159
The Kubernetes connector provides the following configuration:
160160

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,8 @@ Pass the following parameters to TaskRun:
122122
- Specify the `buildkitd-config` workspace as the `buildkitd` configuration of the OCI connector, thereby mounting `buildkitd.toml`.
123123
- Adjust the target image address for the push to the proxy address.
124124

125+
{/* lint-ignore code-block-split-list */}
126+
125127
```shell
126128
kubectl create -f - <<EOF
127129
apiVersion: tekton.dev/v1beta1

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,12 +127,13 @@ kubectl create secret docker-registry oci-connector-secret \
127127

128128
**Explanation:**
129129

130-
- The `docker-server` points to the connector proxy service address in the cluster, you can get the address from the connector status
130+
The `docker-server` points to the connector proxy service address in the cluster, you can get the address from the connector status
131131

132132
```bash
133133
$ kubectl get connectors.connector harbor -n oci-connector-demo -o jsonpath='{.status.proxy.httpAddress.url}'
134134
http://192.168.x.x:31567/namespaces/oci-connector-demo/connectors/harbor
135135
```
136+
136137
- The `docker-username` is set to "u" (a placeholder username)
137138
- The `docker-password` uses the Service Account token from the previous step
138139
- The `docker-email` can be any valid email address (used for Docker registry compatibility)

‎docs/en/connectors/concepts/connector_scope_permissions.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ All Connector resources are utilized within the cluster and cannot be used acros
1919
Resources created at different levels have different access permissions and are established under different namespaces.
2020

2121
- Cluster Level: Under the `kube-public` namespace, shared by the current cluster.
22-
- Project Level: Under the namespace named after the project, shared within the current cluster for that project’s namespace.
22+
- Project Level: Under the namespace named after the project, shared within the current cluster for that project's namespace.
2323
- Namespace Level: Connectors in regular namespaces can only be accessed by the current namespace.
2424

2525
## Cluster Level

‎docs/en/connectors/concepts/connectorclass.mdx‎

Lines changed: 108 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ spec:
216216

217217
### Example
218218

219-
- Basic Auth authentication checking
219+
Basic Auth authentication checking
220220

221221
```yaml
222222
spec:
@@ -688,127 +688,127 @@ It is recommended to confirm the scope of impact when updating the ConnectorClas
688688

689689
- ConnectorClass supporting `basic-auth` authentication type
690690

691-
```yaml
692-
apiVersion: connectors.alauda.io/v1alpha1
693-
kind: ConnectorClass
694-
metadata:
695-
name: git
696-
spec:
697-
address:
698-
type: string
699-
auth:
700-
types:
701-
- name: basicAuth
702-
secretType: kubernetes.io/basic-auth
703-
optional: true
704-
```
691+
```yaml
692+
apiVersion: connectors.alauda.io/v1alpha1
693+
kind: ConnectorClass
694+
metadata:
695+
name: git
696+
spec:
697+
address:
698+
type: string
699+
auth:
700+
types:
701+
- name: basicAuth
702+
secretType: kubernetes.io/basic-auth
703+
optional: true
704+
```
705705

706706
- Custom authentication type ConnectorClass
707707

708-
```yaml
709-
apiVersion: connectors.alauda.io/v1alpha1
710-
kind: ConnectorClass
711-
metadata:
712-
name: sample
713-
spec:
714-
address:
715-
type: string
716-
auth:
717-
types:
718-
- name: patAuth
719-
optional: true
720-
secretType: Opaque
721-
params:
722-
- name: username
723-
- name: privateToken
724-
```
708+
```yaml
709+
apiVersion: connectors.alauda.io/v1alpha1
710+
kind: ConnectorClass
711+
metadata:
712+
name: sample
713+
spec:
714+
address:
715+
type: string
716+
auth:
717+
types:
718+
- name: patAuth
719+
optional: true
720+
secretType: Opaque
721+
params:
722+
- name: username
723+
- name: privateToken
724+
```
725725

726726
- ConnectorClass configured with `liveness probe`
727727

728-
```yaml
729-
apiVersion: connectors.alauda.io/v1alpha1
730-
kind: ConnectorClass
731-
metadata:
732-
name: git
733-
spec:
734-
address:
735-
type: string
736-
auth:
737-
types:
738-
- name: basicAuth
739-
optional: true
740-
secretType: kubernetes.io/basic-auth
741-
livenessProbe:
742-
http:
743-
path: /
744-
```
728+
```yaml
729+
apiVersion: connectors.alauda.io/v1alpha1
730+
kind: ConnectorClass
731+
metadata:
732+
name: git
733+
spec:
734+
address:
735+
type: string
736+
auth:
737+
types:
738+
- name: basicAuth
739+
optional: true
740+
secretType: kubernetes.io/basic-auth
741+
livenessProbe:
742+
http:
743+
path: /
744+
```
745745

746746
- ConnectorClass configured with `auth probe`
747747

748-
```yaml
749-
apiVersion: connectors.alauda.io/v1alpha1
750-
kind: ConnectorClass
751-
metadata:
752-
name: git
753-
labels:
754-
connectors.cpaas.io/git: "true"
755-
spec:
756-
address:
757-
type: string
758-
auth:
759-
types:
760-
- name: basicAuth
761-
secretType: kubernetes.io/basic-auth
762-
optional: true
763-
livenessProbe:
764-
http:
765-
path: /
766-
authProbes:
767-
- authName: basicAuth
768-
params:
769-
- name: repository
770-
type: string
771-
probe:
748+
```yaml
749+
apiVersion: connectors.alauda.io/v1alpha1
750+
kind: ConnectorClass
751+
metadata:
752+
name: git
753+
labels:
754+
connectors.cpaas.io/git: "true"
755+
spec:
756+
address:
757+
type: string
758+
auth:
759+
types:
760+
- name: basicAuth
761+
secretType: kubernetes.io/basic-auth
762+
optional: true
763+
livenessProbe:
772764
http:
773-
path: /{{- range .Connector.Spec.Auth.Params }}{{- if eq .Name "repository" }}{{ .Value.StringVal }}{{ end }}{{- end }}/info/refs?service=git-upload-pack
774-
httpHeaders:
775-
- name: Authorization
776-
value: >-
777-
{{- if .Secret }}Basic {{ printf "%s:%s" .Secret.StringData.username .Secret.StringData.password | b64enc }} {{- end }}
778-
```
765+
path: /
766+
authProbes:
767+
- authName: basicAuth
768+
params:
769+
- name: repository
770+
type: string
771+
probe:
772+
http:
773+
path: /{{- range .Connector.Spec.Auth.Params }}{{- if eq .Name "repository" }}{{ .Value.StringVal }}{{ end }}{{- end }}/info/refs?service=git-upload-pack
774+
httpHeaders:
775+
- name: Authorization
776+
value: >-
777+
{{- if .Secret }}Basic {{ printf "%s:%s" .Secret.StringData.username .Secret.StringData.password | b64enc }} {{- end }}
778+
```
779779

780780
- Complete Git connector configuration example:
781781

782-
```yaml
783-
apiVersion: connectors.alauda.io/v1alpha1
784-
kind: ConnectorClass
785-
metadata:
786-
name: git
787-
spec:
788-
address:
789-
name: address
790-
type: string
791-
auth:
792-
types:
793-
- name: basicAuth
794-
secretType: kubernetes.io/basic-auth
795-
optional: true
796-
livenessProbe:
797-
http:
798-
path: /
799-
authProbes:
800-
- authName: basicAuth
801-
params:
802-
- name: repository
803-
type: string
804-
probe:
782+
```yaml
783+
apiVersion: connectors.alauda.io/v1alpha1
784+
kind: ConnectorClass
785+
metadata:
786+
name: git
787+
spec:
788+
address:
789+
name: address
790+
type: string
791+
auth:
792+
types:
793+
- name: basicAuth
794+
secretType: kubernetes.io/basic-auth
795+
optional: true
796+
livenessProbe:
805797
http:
806-
path: /{{- range .Connector.Spec.Auth.Params }}{{- if eq .Name "repository" }}{{ .Value.StringVal }}{{ end }}{{- end }}/info/refs?service=git-upload-pack
807-
httpHeaders:
808-
- name: Authorization
809-
value: >-
810-
{{- if .Secret }}Basic {{ printf "%s:%s" .Secret.StringData.username .Secret.StringData.password | b64enc }} {{- end }}
811-
```
798+
path: /
799+
authProbes:
800+
- authName: basicAuth
801+
params:
802+
- name: repository
803+
type: string
804+
probe:
805+
http:
806+
path: /{{- range .Connector.Spec.Auth.Params }}{{- if eq .Name "repository" }}{{ .Value.StringVal }}{{ end }}{{- end }}/info/refs?service=git-upload-pack
807+
httpHeaders:
808+
- name: Authorization
809+
value: >-
810+
{{- if .Secret }}Basic {{ printf "%s:%s" .Secret.StringData.username .Secret.StringData.password | b64enc }} {{- end }}
811+
```
812812

813813
## More
814814

‎docs/en/overview/lifecycle_policy.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Below is the lifecycle timeline for released versions of the `Alauda DevOps Conn
1010

1111
| Version | Release Date | End of Support |
1212
| ------- | ------------ | -------------- |
13-
| v1.2.z | 2025-08-22 | 2025-12-22 |
13+
| v1.2.z | 2025-08-27 | 2025-12-27 |
1414
| v1.1.z | 2025-07-15 | 2025-11-15 |
1515
| v1.0.z | 2025-04-08 | 2025-07 |
1616

‎docs/en/overview/release_notes.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ The following table shows the compatibility and support matrix between the Alaud
1919

2020
| Alauda DevOps Connectors Operator Version | ACP Version |
2121
| ----------------------------------------- | ----------- |
22-
| v1.2.0 | v4.1, v4.0 |
22+
| v1.2.1 | v4.1, v4.0 |
2323
| v1.1.0 | v4.1, v4.0 |
2424
| v1.0.8 | v4.0 |
2525
| v1.0.4 | v4.0 |
2626

27-
## v1.2.0
27+
## v1.2.1
2828

2929
### Features and Enhancements
3030

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../../config/crd/bases/

0 commit comments

Comments
 (0)