Skip to content

Commit 564e912

Browse files
author
edge-katanomi-app2[bot]
committed
📚 Sync docs from alaudadevops/connectors-operator on 70aaeff838a947d719defe936fb70ee3d8145096
Source: add docs about resourceinterface (#262) Author: chengjingtao Ref: refs/heads/main Commit: 70aaeff838a947d719defe936fb70ee3d8145096 This commit automatically syncs documentation changes from the source-docs repository. 🔗 View source commit: https://github.com/alaudadevops/connectors-operator/commit/70aaeff838a947d719defe936fb70ee3d8145096 🤖 Synced on 2025-10-17 04:02:51 UTC
1 parent 39f8e9f commit 564e912

File tree

6 files changed

+427
-9
lines changed

6 files changed

+427
-9
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-10-14 07:30:23 UTC
3+
- **Last synced**: 2025-10-17 04:02:51 UTC
44
- **Source repository**: alaudadevops/connectors-operator
5-
- **Source commit**: [84f45e1e345b9690263da0555b4249400a48c255](https://github.com/alaudadevops/connectors-operator/commit/84f45e1e345b9690263da0555b4249400a48c255)
5+
- **Source commit**: [70aaeff838a947d719defe936fb70ee3d8145096](https://github.com/alaudadevops/connectors-operator/commit/70aaeff838a947d719defe936fb70ee3d8145096)
66
- **Triggered by**: edge-katanomi-app2[bot]
7-
- **Workflow run**: [#38](https://github.com/alaudadevops/connectors-operator/actions/runs/18488959742)
7+
- **Workflow run**: [#41](https://github.com/alaudadevops/connectors-operator/actions/runs/18582030603)
88

99
## Files synced:
1010
- docs/
57.8 KB
Loading

‎docs/en/connectors/architecture/index.mdx‎

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ This API is very useful in practical applications, such as:
6767

6868
The implementation of the `Connectors API` is based on the underlying capabilities provided by the `ConnectorClass API`.
6969

70-
# ConnectorClass API
70+
## ConnectorClass API
7171

7272
`ConnectorClass API` defines the APIs provided by specific types of tools.
7373

@@ -78,10 +78,24 @@ Different types of tools can offer various API capabilities, for example:
7878

7979
Developers can define unique API capabilities for each `ConnectorClass`, and these capabilities will ultimately be exposed to clients through the `Connectors API`.
8080

81-
# Connectors CSI Driver
81+
## Connectors CSI Driver
8282

8383
To facilitate easier utilization of Connectors-Proxy capabilities by K8S workloads, we can use the Connectors CSI Driver.
8484

8585
The Connectors CSI Driver can mount the rendered contents of the configuration file templates maintained within the ConnectorClass into the workload. The configuration file can include information for accessing the `Connectors Proxy`, enabling users to utilize Connectors Proxy capabilities with minimal modifications to their original scripts.
8686

8787
For more information, refer to [connectors csi driver](../concepts/connectors_csi.mdx)
88+
89+
## ResourceInterface
90+
91+
`ResourceInterface` is a standardized abstraction that defines how external resources (like Git repositories, OCI container images, artifact repositories) can be integrated into pipeline workflows.
92+
93+
When building CI/CD pipelines, users traditionally need to manually configure resource URLs, git branch/tag, OCI image tag, artifact repository, and authentication credentials for different external tools. This manual process is complex, error-prone, and makes pipeline configurations tightly coupled to specific tool instances.
94+
95+
ResourceInterface solves this by providing standard resource abstraction like "GitCodeRepository", "OCIArtifact", and "MavenArtifact". Instead of manually entering URLs like `https://github.com/myorg/myapp.git`, users can select a connector, browse resources through the UI, and the system automatically generates the correct configuration and credentials for the pipeline.
96+
97+
This approach provides a consistent, user-friendly experience across different tools while maintaining flexibility to support various implementations.
98+
99+
For more information, refer to [ResourceInterface](../concepts/resource_interface.mdx).
100+
101+
If you want to integrate Connector in your custom Pipeline or Task, please refer to <ExternalSiteLink name="pipelines" href="/pipelines/concepts/integrate_with_connector.html" children="Pipeline Integration" />

0 commit comments

Comments
 (0)