mirror of https://github.com/artifacthub/hub.git
Document keptn annotations (#1561)
Signed-off-by: Sergio Castaño Arteaga <tegioz@icloud.com>
This commit is contained in:
Sergio C. Arteaga
GitHub
parent
425d5d4fff
commit
23a49728c1
|
|
@ -0,0 +1,22 @@
|
|||
# Keptn annotations
|
||||
|
||||
You can provide some extra information about your Keptn integrations by using the `annotations` field in the [Artifact Hub package metadata file](https://github.com/artifacthub/hub/blob/master/docs/metadata/artifacthub-pkg.yml).
|
||||
|
||||
## Supported annotations
|
||||
|
||||
- **keptn/kind** *(string)*
|
||||
|
||||
This annotation allows providing the kind of the integration. Supported values: *service* and *sli-provider*. It's possible to add multiple kinds by using a comma separated list, like shown in the example below.
|
||||
|
||||
- **keptn/version** *(string)*
|
||||
|
||||
Use this annotation to provide the Keptn version(s) your integration is compatible with.
|
||||
|
||||
## Example
|
||||
|
||||
```yaml
|
||||
...
|
||||
annotations:
|
||||
keptn/kind: "service,sli-provider"
|
||||
keptn/version: "0.8.4-0.8.7"
|
||||
```
|
||||
|
|
@ -14,7 +14,7 @@ This annotation can be provided using two different formats: using a plain list
|
|||
|
||||
- **artifacthub.io/displayName** *(string)*
|
||||
|
||||
This annotations allows providing a nicely formatted name for the package.
|
||||
This annotation allows providing a nicely formatted name for the package.
|
||||
|
||||
- **artifacthub.io/keywords** *(yaml string, see example below)*
|
||||
|
||||
|
|
|
|||
|
|
@ -163,7 +163,7 @@ oras push \
|
|||
artifacthub-repo.yml:application/vnd.cncf.artifacthub.repository-metadata.layer.v1.yaml
|
||||
```
|
||||
|
||||
The repository metadata file is pushed to the registry using a special tag named `artifacthub.io`. Artifact Hub will pull that image looking for the `application/vnd.cncf.artifacthub.repository-metadata.layer.v1.yaml` layer when the repository metadata is needed.
|
||||
The repository metadata file is pushed to the registry using a special tag named `artifacthub.io`. Artifact Hub will pull that artifact looking for the `application/vnd.cncf.artifacthub.repository-metadata.layer.v1.yaml` layer when the repository metadata is needed.
|
||||
|
||||
Please note that there are some features that are not yet available for Helm repositories stored in OCI registries:
|
||||
|
||||
|
|
@ -290,7 +290,7 @@ path/to/packages
|
|||
|
||||
In the previous case, even the `package1` directory could be omitted. The reason is that both packages names and versions are read from the `artifacthub-pkg.yml` metadata file, so directories names are not used at all.
|
||||
|
||||
Each package version **needs** an `artifacthub-pkg.yml` metadata file. Please see the file [spec](https://github.com/artifacthub/hub/blob/master/docs/metadata/artifacthub-pkg.yml) for more details. The [artifacthub-repo.yml](https://github.com/artifacthub/hub/blob/master/docs/metadata/artifacthub-repo.yml) repository metadata file shown above can be used to setup features like [Verified Publisher](#verified-publisher) or [Ownership claim](#ownership-claim). This file must be located at `/path/to/packages`.
|
||||
Each package version **needs** an `artifacthub-pkg.yml` metadata file. Please see the file [spec](https://github.com/artifacthub/hub/blob/master/docs/metadata/artifacthub-pkg.yml) and the [Keptn annotations documentation](https://github.com/artifacthub/hub/blob/master/docs/keptn_annotations.md) for more details. The [artifacthub-repo.yml](https://github.com/artifacthub/hub/blob/master/docs/metadata/artifacthub-repo.yml) repository metadata file shown above can be used to setup features like [Verified Publisher](#verified-publisher) or [Ownership claim](#ownership-claim). This file must be located at `/path/to/packages`.
|
||||
|
||||
Once you have added your repository, you are all set up. As you add new versions of your integrations packages or even new packages to your git repository, they'll be automatically indexed and listed in Artifact Hub.
|
||||
|
||||
|
|
@ -505,8 +505,6 @@ Repositories and the packages they provide can display a special label named `Ve
|
|||
|
||||
Publishers can be verified through the [artifacthub-repo.yml](https://github.com/artifacthub/hub/blob/master/docs/metadata/artifacthub-repo.yml) repository metadata file. In the repositories tab in the Artifact Hub control panel, the repository identifier is exposed on each repository's card (ID). To proceed with the verification, an `artifacthub-repo.yml` metadata file must be added to the repository including that **ID** in the `repositoryID` field. The next time the repository is processed, the verification will be checked and the flag will be enabled if it succeeds.
|
||||
|
||||
*This feature is not yet available for OCI based repositories.*
|
||||
|
||||
*Please note that the **artifacthub-repo.yml** metadata file must be located at the repository URL's path. In Helm repositories, for example, this means it must be located at the same level of the chart repository **index.yaml** file, and it must be served from the chart repository HTTP server as well.*
|
||||
|
||||
*The verified publisher flag won't be set until the next time the repository is processed. Please keep in mind that the repository won't be processed if it hasn't changed since the last time it was processed. Depending on the repository kind, this is checked in a different way. For Helm http based repositories, we consider it has changed if the `index.yaml` file changes (the `generated` field is ignored when performing this check). For git based repositories, it does when the hash of the last commit in the branch you set up changes.*
|
||||
|
|
@ -533,8 +531,6 @@ First, an [artifacthub-repo.yml](https://github.com/artifacthub/hub/blob/master/
|
|||
|
||||
Once the repository metadata file has been set up, you can proceed from the Artifact Hub control panel. In the repositories tab, click on `Claim Ownership`. You'll need to enter the repository you'd like to claim the ownership for, as well as the destination entity, which can be the user performing the request or an organization. If the metadata file was set up correctly, the process should complete successfully.
|
||||
|
||||
*This feature is not yet available for OCI based repositories.*
|
||||
|
||||
*Please note that the **artifacthub-repo.yml** metadata file must be located at the repository URL's path. In Helm repositories, for example, this means it must be located at the same level of the chart repository **index.yaml** file, and it must be served from the chart repository HTTP server as well.*
|
||||
|
||||
## Private repositories
|
||||
|
|
|
|||
|
|
@ -16,6 +16,7 @@ The documentation is organized in the following topics:
|
|||
| [OLM annotations](/docs/topics/annotations/olm) | Describes some custom annotations that allow enriching the existing metadata in OLM operators to improve users' experience in Artifact Hub. |
|
||||
| [Krew annotations](/docs/topics/annotations/krew) | Describes some custom annotations that allow enriching the existing metadata in Krew kubectl plugins to improve users' experience in Artifact Hub. |
|
||||
| [Tekton annotations](/docs/topics/annotations/tekton) | Describes some custom annotations that allow enriching the existing metadata in Tekton tasks to improve users' experience in Artifact Hub. |
|
||||
| [keptn annotations](/docs/topics/annotations/keptn) | Describes some custom annotations that allow enriching the existing metadata in Keptn integrations to improve users' experience in Artifact Hub. |
|
||||
| [Packages security report](/docs/topics/security_report) | Explains how packages are scanned for security vulnerabilities and the structure of the security report. |
|
||||
| [Authorization](/docs/topics/authorization) | Explains how the authorization mechanism that allows organizations to define what actions can be performed by their members works and how to set it up. |
|
||||
| [Architecture](/docs/topics/architecture) | Describes the components that form Artifact Hub, what each of them do and the layout of the source repository. |
|
||||
|
|
|
|||
|
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
title: "Keptn"
|
||||
weight: 4
|
||||
aliases: [
|
||||
"/keptn_annotations",
|
||||
]
|
||||
---
|
||||
|
|
@ -11,3 +11,4 @@ cat docs/www/headers/helm_annotations docs/helm_annotations.md > docs/www/conten
|
|||
cat docs/www/headers/olm_annotations docs/olm_annotations.md > docs/www/content/topics/annotations/olm.md
|
||||
cat docs/www/headers/krew_annotations docs/krew_annotations.md > docs/www/content/topics/annotations/krew.md
|
||||
cat docs/www/headers/tekton_annotations docs/tekton_annotations.md > docs/www/content/topics/annotations/tekton.md
|
||||
cat docs/www/headers/keptn_annotations docs/keptn_annotations.md > docs/www/content/topics/annotations/keptn.md
|
||||
|
|
|
|||
Loading…
Reference in New Issue