From 776d587c88115b1d827c68fef7b58ca9472f88d4 Mon Sep 17 00:00:00 2001 From: zongz Date: Sun, 8 Oct 2023 16:34:09 +0800 Subject: [PATCH] feat: init the metadata repo Signed-off-by: zongz --- README.md | 7 ++-- k8s/1.27/README.md | 0 k8s/1.27/artifacthub-pkg.yml | 68 ++++++++++++++++++++++++++++++++++++ k8s/1.28/README.md | 0 k8s/1.28/artifacthub-pkg.yml | 68 ++++++++++++++++++++++++++++++++++++ 5 files changed, 141 insertions(+), 2 deletions(-) create mode 100644 k8s/1.27/README.md create mode 100644 k8s/1.27/artifacthub-pkg.yml create mode 100644 k8s/1.28/README.md create mode 100644 k8s/1.28/artifacthub-pkg.yml diff --git a/README.md b/README.md index ada80c34..92b4854d 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,5 @@ -# artifacthub -ArtifactHub Repo for KCL Integrations +# KCL Integrations ArtifactHub + +This repository holds the metadata for KCL package to be listed on the ArtifactHub and consequently KCL docs integration page. + +Each KCL package listed consists of at least an `artifacthub-pkg.yml` file, as well as `README.md` file. diff --git a/k8s/1.27/README.md b/k8s/1.27/README.md new file mode 100644 index 00000000..e69de29b diff --git a/k8s/1.27/artifacthub-pkg.yml b/k8s/1.27/artifacthub-pkg.yml new file mode 100644 index 00000000..bb9f887d --- /dev/null +++ b/k8s/1.27/artifacthub-pkg.yml @@ -0,0 +1,68 @@ +# Artifact Hub package metadata file +version: A SemVer 2 version (required) +name: The name of the package (only alphanum, no spaces, dashes allowed) (required) +alternativeName: Alternative name of the package (optional) +category: Category of the package (optional) # One of: ai-machine-learning, database, integration-delivery, monitoring-logging, networking, security, storage, streaming-messaging or skip-prediction +displayName: The name of the package nicely formatted (required) +createdAt: The date this package was created (RFC3339 layout) (required) +description: A short description of the package (required) +logoPath: Path to the logo image file relative to the package directory (optional, but it improves package visibility) +logoURL: The URL of the logo image (optional, an alternative to logoPath if the image is hosted somewhere else) +digest: String that uniquely identifies this package version (optional) +license: SPDX identifier of the package license (https://spdx.org/licenses/) (optional) +homeURL: The URL of the project home page (optional) +appVersion: The version of the app that this contains (optional) +containersImages: # (optional) + - name: Image identifier (optional) + image: The format should match ${REGISTRYHOST}/${USERNAME}/${NAME}:${TAG} + whitelisted: When set to true, this image won't be scanned for security vulnerabilities + platforms: # (optional) + - A list of platforms supported by this image (linux/amd64, etc) +containsSecurityUpdates: Whether this package version contains security updates (optional, boolean) +operator: Whether this package is an Operator (optional, boolean) +deprecated: Whether this package is deprecated (optional, boolean) +prerelease: Whether this package version is a pre-release (optional, boolean) +keywords: # (optional) + - A list of keywords about this package + - Using one or more categories names as keywords will improve package visibility +links: # (optional) + - name: Title of the link (required for each link) + url: URL of the link (required for each link) +readme: | # (optional, can be provided from a README.md file as well) + Package documentation in markdown format + + Content added here will be rendered on Artifact Hub +install: | # (optional) + Brief install instructions in markdown format + + Content added here will be displayed when the INSTALL button on the package details page is clicked. +changes: # (optional - it is also possible to provide a list of strings with just the descriptions instead of using objects) + - kind: added # Supported kinds are: added, changed, deprecated, removed, fixed and security + description: cool feature + links: + - name: GitHub Issue + url: https://github.com/issue-url + - name: GitHub PR + url: https://github.com/pr-url + - kind: fixed + description: minor bug + links: + - name: GitHub Issue + url: https://github.com/issue-url +maintainers: # (optional) + - name: The maintainer name (required for each maintainer) + email: The maintainer email (required for each maintainer) +provider: # (optional) + name: The name of the individual, company, or service that provides this package +ignore: # (optional, used to ignore some falco rules or opa policies files in a package) + - lib # Entries use .gitignore syntax) +recommendations: # (optional, list of recommended packages) + - url: https://artifacthub.io/packages/helm/artifact-hub/artifact-hub +screenshots: # (optional, list of screenshots) + - title: Sample screenshot 1 + url: https://example.com/screenshot1.jpg + - title: Sample screenshot 2 + url: https://example.com/screenshot2.jpg +annotations: # (optional, keys and values must be strings) + key1: value1 + key2: value2 \ No newline at end of file diff --git a/k8s/1.28/README.md b/k8s/1.28/README.md new file mode 100644 index 00000000..e69de29b diff --git a/k8s/1.28/artifacthub-pkg.yml b/k8s/1.28/artifacthub-pkg.yml new file mode 100644 index 00000000..bb9f887d --- /dev/null +++ b/k8s/1.28/artifacthub-pkg.yml @@ -0,0 +1,68 @@ +# Artifact Hub package metadata file +version: A SemVer 2 version (required) +name: The name of the package (only alphanum, no spaces, dashes allowed) (required) +alternativeName: Alternative name of the package (optional) +category: Category of the package (optional) # One of: ai-machine-learning, database, integration-delivery, monitoring-logging, networking, security, storage, streaming-messaging or skip-prediction +displayName: The name of the package nicely formatted (required) +createdAt: The date this package was created (RFC3339 layout) (required) +description: A short description of the package (required) +logoPath: Path to the logo image file relative to the package directory (optional, but it improves package visibility) +logoURL: The URL of the logo image (optional, an alternative to logoPath if the image is hosted somewhere else) +digest: String that uniquely identifies this package version (optional) +license: SPDX identifier of the package license (https://spdx.org/licenses/) (optional) +homeURL: The URL of the project home page (optional) +appVersion: The version of the app that this contains (optional) +containersImages: # (optional) + - name: Image identifier (optional) + image: The format should match ${REGISTRYHOST}/${USERNAME}/${NAME}:${TAG} + whitelisted: When set to true, this image won't be scanned for security vulnerabilities + platforms: # (optional) + - A list of platforms supported by this image (linux/amd64, etc) +containsSecurityUpdates: Whether this package version contains security updates (optional, boolean) +operator: Whether this package is an Operator (optional, boolean) +deprecated: Whether this package is deprecated (optional, boolean) +prerelease: Whether this package version is a pre-release (optional, boolean) +keywords: # (optional) + - A list of keywords about this package + - Using one or more categories names as keywords will improve package visibility +links: # (optional) + - name: Title of the link (required for each link) + url: URL of the link (required for each link) +readme: | # (optional, can be provided from a README.md file as well) + Package documentation in markdown format + + Content added here will be rendered on Artifact Hub +install: | # (optional) + Brief install instructions in markdown format + + Content added here will be displayed when the INSTALL button on the package details page is clicked. +changes: # (optional - it is also possible to provide a list of strings with just the descriptions instead of using objects) + - kind: added # Supported kinds are: added, changed, deprecated, removed, fixed and security + description: cool feature + links: + - name: GitHub Issue + url: https://github.com/issue-url + - name: GitHub PR + url: https://github.com/pr-url + - kind: fixed + description: minor bug + links: + - name: GitHub Issue + url: https://github.com/issue-url +maintainers: # (optional) + - name: The maintainer name (required for each maintainer) + email: The maintainer email (required for each maintainer) +provider: # (optional) + name: The name of the individual, company, or service that provides this package +ignore: # (optional, used to ignore some falco rules or opa policies files in a package) + - lib # Entries use .gitignore syntax) +recommendations: # (optional, list of recommended packages) + - url: https://artifacthub.io/packages/helm/artifact-hub/artifact-hub +screenshots: # (optional, list of screenshots) + - title: Sample screenshot 1 + url: https://example.com/screenshot1.jpg + - title: Sample screenshot 2 + url: https://example.com/screenshot2.jpg +annotations: # (optional, keys and values must be strings) + key1: value1 + key2: value2 \ No newline at end of file