Skip to content

Commit 98e3c5c

Browse files
authored
docs: add list and how to use (#198)
Signed-off-by: Miguel Martinez Trivino <[email protected]>
1 parent a52622b commit 98e3c5c

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ Operators can set up third-party integrations such as [Dependency-Track](https:/
108108

109109
Ops can mix and match with different integrations while **not requiring developers to make any changes on their side**!
110110

111-
To learn more and to find the list of available integrations, check our [integrations page](./docs/integrations.md)
111+
To learn more and to find the list of available integrations, check our [integrations page](./docs/integrations.md).
112112

113113
### Role-tailored experience
114114

docs/integrations.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Chainloop Integrations
22

3-
Operators can set up third-party integrations that extend Chainloop functionality by operating on your attestation metadata. This logic could go from sending a Slack message, uploading the attestation to a storage backend or sending a Software Bill Of Materials (SBOMs) to a third-party for analysis.
3+
Operators can extend Chainloop functionality by setting up third-party integrations that operate on your attestation metadata. Integrations can range from sending a Slack message, uploading the attestation to a storage backend or sending a Software Bill Of Materials (SBOMs) to a third-party service for analysis, for example.
44

55
Below you can find the list of currently available integrations. If you can't find the integration you are looking for, feel free [to reach out](https://github.com/chainloop-dev/chainloop/issues) or [contribute your own](https://github.com/chainloop-dev/chainloop/blob/main/app/controlplane/plugins/README.md)!
66

@@ -17,7 +17,7 @@ Below you can find the list of currently available integrations. If you can't fi
1717

1818
## How to use integrations
1919

20-
First you need to make sure that the integration that you are looking for is available in your Chainloop instance, to do so you will
20+
First, you need to make sure that the integration that you are looking for is available in your Chainloop instance, to do so you will:
2121

2222
```console
2323
$ chainloop integration available list
@@ -34,9 +34,9 @@ $ chainloop integration available list
3434
└──────────────────┴─────────┴──────────────────────┴───────────────────────────────────────────────────────────┘
3535
```
3636

37-
Once you find the integration you are looking for, i.e `oci-registry`, it's time to configure them.
37+
Once you find your integration, i.e `oci-registry`, it's time to configure it.
3838

39-
Configuring an extension has two steps: 1) register the extension in your organization and 2)attach the extension to your workflows.
39+
Configuring an extension has two steps: 1) register it in your organization and 2) attach the registered integration to your workflows.
4040

4141
### Registering an extension
4242

@@ -69,7 +69,7 @@ chainloop integration available describe --id oci-registry
6969
└────────┴────────┴──────────┴────────────────────────────────────────────┘
7070
```
7171

72-
In the console output we can see a registration section that indicates that 3 parameters are required, let's go ahead and register it by using our Google Artifact Registry Credentials, for example.
72+
In the console output we can see a registration section that indicates that 3 parameters are required, let's go ahead and register it using our Google Artifact Registry Credentials by running:
7373

7474
```console
7575
$ chainloop integration registered add oci-registry \
@@ -85,7 +85,7 @@ $ chainloop integration registered add oci-registry \
8585

8686
Once the integration is registered, we can attach it to any workflow. In practice this means that attestations and material information received by this workflow will be sent to the registered integration.
8787

88-
Attachment has at least two required parameters, the workflowID and the registered integration ID. Additionally each integration might have additional configuration parameters that could allow you to customize its behavior. In our case, on the table above, you can see that the `oci-registry` integration has an optional attachment parameter called `prefix` that allows you to customize the name of the image that will be pushed to the registry.
88+
The attachment process has at least two required parameters, the `workflowID` and the registered `integrationID`. Additionally each integration might have additional to customize its behavior per-workflow. In our case, on the table above, we can see that the `oci-registry` integration has an optional parameter called `prefix` that allows you to customize the name of the image that will be pushed to the registry.
8989

9090
```console
9191
$ chainloop integration attached add --workflow $WID --integration $IID --opt prefix=custom-prefix

0 commit comments

Comments
 (0)