You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/integrations.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,24 +2,24 @@
2
2
3
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.
4
4
5
-
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)!
6
-
7
5

8
6
7
+
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)!
8
+
9
9
## Available Integrations
10
10
11
11
| ID | Version | Description | Material Requirement |
12
12
| --- | --- | --- | --- |
13
-
|[dependency-track](https:/github.com/chainloop-dev/chainloop/blob/main/app/controlplane/plugins/core/dependency-track/v1/README.md)| 1.2 | Send CycloneDX SBOMs to your Dependency-Track instance | SBOM_CYCLONEDX_JSON |
14
-
|[smtp](https:/github.com/chainloop-dev/chainloop/blob/main/app/controlplane/plugins/core/smtp/v1/README.md)| 1.0 | Send emails with information about a received attestation ||
15
-
|[oci-registry](https:/github.com/chainloop-dev/chainloop/blob/main/app/controlplane/plugins/core/oci-registry/v1/README.md)| 1.0 | Send attestations to a compatible OCI registry ||
16
-
|[discord-webhook](https:/github.com/chainloop-dev/chainloop/blob/main/app/controlplane/plugins/core/discord-webhook/v1/README.md)| 1.1 | Send attestations to Discord ||
13
+
|[dependency-track](https:/github.com/chainloop-dev/chainloop/tree/main/app/controlplane/plugins/core/dependency-track/v1)| 1.2 | Send CycloneDX SBOMs to your Dependency-Track instance | SBOM_CYCLONEDX_JSON |
14
+
|[smtp](https:/github.com/chainloop-dev/chainloop/tree/main/app/controlplane/plugins/core/smtp/v1)| 1.0 | Send emails with information about a received attestation ||
15
+
|[oci-registry](https:/github.com/chainloop-dev/chainloop/tree/main/app/controlplane/plugins/core/oci-registry/v1)| 1.0 | Send attestations to a compatible OCI registry ||
16
+
|[discord-webhook](https:/github.com/chainloop-dev/chainloop/tree/main/app/controlplane/plugins/core/discord-webhook/v1)| 1.1 | Send attestations to Discord ||
17
17
18
18
## How to use integrations
19
19
20
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:
│ ID │ VERSION │ MATERIAL REQUIREMENT │ DESCRIPTION │
@@ -36,16 +36,16 @@ $ chainloop integration available list
36
36
37
37
Once you find your integration, i.e `oci-registry`, it's time to configure it.
38
38
39
-
Configuring an extension has two steps: 1) register it in your organization and 2) attach the registered integration to your workflows.
39
+
Configuring a integration has two steps: 1) register it in your organization and 2) attach the registered integration to your workflows.
40
40
41
-
### Registering an extension
41
+
### Registering an integration
42
42
43
43
Registration is when a specific instance of the integration is configured on a Chainloop organization. A registered instance is then available to be attached to any workflow.
44
44
45
45
In our case, we want to register an instance of the `oci-registry` integration. To do so, we need to first figure out what configuration parameters are required by the integration. We can do so by running:
46
46
47
-
```console
48
-
chainloop integration available describe --id oci-registry
47
+
```sh
48
+
$ chainloop integration available describe --id oci-registry
@@ -71,7 +71,7 @@ chainloop integration available describe --id oci-registry
71
71
72
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:
> Note: You can find more examples on how to configure this specific integration [here](https://github.com/chainloop-dev/chainloop/tree/main/app/controlplane/plugins/core/oci-registry/v1)
83
83
84
-
### Attaching an extension
84
+
### Attaching an integration
85
85
86
86
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.
0 commit comments