From b76ae638462ab0f673e5915986070518dd3f9ad3 Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Thu, 19 Aug 2021 09:08:42 +0000 Subject: Add latest changes from gitlab-org/gitlab@14-2-stable-ee --- doc/api/packages/debian.md | 128 +++++++++++++++++++---- doc/api/packages/debian_group_distributions.md | 33 +++--- doc/api/packages/debian_project_distributions.md | 32 +++--- doc/api/packages/helm.md | 3 +- 4 files changed, 138 insertions(+), 58 deletions(-) (limited to 'doc/api/packages') diff --git a/doc/api/packages/debian.md b/doc/api/packages/debian.md index cd97bd609df..154c99d7e0a 100644 --- a/doc/api/packages/debian.md +++ b/doc/api/packages/debian.md @@ -4,7 +4,11 @@ group: Package info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Debian API +# Debian API **(FREE SELF)** + +> - Debian API [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/42670) in GitLab 13.5. +> - Debian group API [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66188) in GitLab 14.2. +> - [Deployed behind a feature flag](../../user/feature_flags.md), disabled by default. This is the API documentation for [Debian](../../user/packages/debian_repository/index.md). @@ -24,20 +28,17 @@ for details on which headers and token types are supported. ## Enable the Debian API -The Debian API for GitLab is behind a feature flag that is disabled by default. GitLab -administrators with access to the GitLab Rails console can enable this API for your instance. - -To enable it: +The Debian API is behind a feature flag that is disabled by default. +[GitLab administrators with access to the GitLab Rails console](../../administration/feature_flags.md) +can opt to enable it. To enable it, follow the instructions in +[Enable the Debian API](../../user/packages/debian_repository/index.md#enable-the-debian-api). -```ruby -Feature.enable(:debian_packages) -``` +## Enable the Debian group API -To disable it: - -```ruby -Feature.disable(:debian_packages) -``` +The Debian group API is behind a feature flag that is disabled by default. +[GitLab administrators with access to the GitLab Rails console](../../administration/feature_flags.md) +can opt to enable it. To enable it, follow the instructions in +[Enable the Debian group API](../../user/packages/debian_repository/index.md#enable-the-debian-group-api). ## Upload a package file @@ -61,6 +62,38 @@ curl --request PUT \ "https://gitlab.example.com/api/v4/projects/1/packages/debian/mypkg.deb" ``` +## Download a package + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64923) in GitLab 14.2. + +Download a package file. + +```plaintext +GET projects/:id/packages/debian/pool/:distribution/:letter/:package_name/:package_version/:file_name +``` + +| Attribute | Type | Required | Description | +| ----------------- | ------ | -------- | ----------- | +| `distribution` | string | yes | The codename or suite of the Debian distribution. | +| `letter` | string | yes | The Debian Classification (first-letter or lib-first-letter). | +| `package_name` | string | yes | The source package name. | +| `package_version` | string | yes | The source package version. | +| `file_name` | string | yes | The file name. | + +```shell +curl --header "Private-Token: " "https://gitlab.example.com/api/v4/projects/1/packages/pool/my-distro/a/my-pkg/1.0.0/example_1.0.0~alpha2_amd64.deb" +``` + +Write the output to a file: + +```shell +curl --header "Private-Token: " \ + "https://gitlab.example.com/api/v4/projects/1/packages/pool/my-distro/a/my-pkg/1.0.0/example_1.0.0~alpha2_amd64.deb" \ + --remote-name +``` + +This writes the downloaded file using the remote file name in the current directory. + ## Route prefix The remaining endpoints described are two sets of identical routes that each make requests in @@ -95,7 +128,7 @@ The examples in this document all use the project-level prefix. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64067) in GitLab 14.1. -Download a Debian package file. +Download a Debian distribution file. ```plaintext GET /dists/*distribution/Release @@ -117,16 +150,13 @@ curl --header "Private-Token: " \ --remote-name ``` -This writes the downloaded file to `Release` in the current directory. +This writes the downloaded file using the remote file name in the current directory. ## Download a signed distribution Release file > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64067) in GitLab 14.1. -Download a Debian package file. - -Signed releases are [not supported](https://gitlab.com/groups/gitlab-org/-/epics/6057#note_582697034). -Therefore, this endpoint downloads the unsigned release file. +Download a signed Debian distribution file. ```plaintext GET /dists/*distribution/InRelease @@ -148,4 +178,62 @@ curl --header "Private-Token: " \ --remote-name ``` -This writes the downloaded file to `InRelease` in the current directory. +This writes the downloaded file using the remote file name in the current directory. + +## Download a release file signature + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64923) in GitLab 14.2. + +Download a Debian release file signature. + +```plaintext +GET /dists/*distribution/Release.gpg +``` + +| Attribute | Type | Required | Description | +| ----------------- | ------ | -------- | ----------- | +| `distribution` | string | yes | The codename or suite of the Debian distribution. | + +```shell +curl --header "Private-Token: " "https://gitlab.example.com/api/v4/projects/1/packages/debian/dists/my-distro/Release.gpg" +``` + +Write the output to a file: + +```shell +curl --header "Private-Token: " \ + "https://gitlab.example.com/api/v4/projects/1/packages/debian/dists/my-distro/Release.gpg" \ + --remote-name +``` + +This writes the downloaded file using the remote file name in the current directory. + +## Download a binary file's index + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64923) in GitLab 14.2. + +Download a distribution index. + +```plaintext +GET /dists/*distribution/:component/binary-:architecture/Packages +``` + +| Attribute | Type | Required | Description | +| ----------------- | ------ | -------- | ----------- | +| `distribution` | string | yes | The codename or suite of the Debian distribution. | +| `component` | string | yes | The distribution component name. | +| `architecture` | string | yes | The distribution architecture type. | + +```shell +curl --header "Private-Token: " "https://gitlab.example.com/api/v4/projects/1/packages/debian/dists/my-distro/main/amd64/Packages" +``` + +Write the output to a file: + +```shell +curl --header "Private-Token: " \ + "https://gitlab.example.com/api/v4/projects/1/packages/debian/dists/my-distro/main/amd64/Packages" \ + --remote-name +``` + +This writes the downloaded file using the remote file name in the current directory. diff --git a/doc/api/packages/debian_group_distributions.md b/doc/api/packages/debian_group_distributions.md index ba61bf49e01..c5d2effcf44 100644 --- a/doc/api/packages/debian_group_distributions.md +++ b/doc/api/packages/debian_group_distributions.md @@ -4,30 +4,27 @@ group: Package info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Debian group distributions API **(FREE)** +# Debian group distributions API **(FREE SELF)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/5835) in GitLab 14.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/66188) in GitLab 14.2. +> - [Deployed behind a feature flag](../../user/feature_flags.md), disabled by default. -See the [Debian package registry documentation](../../user/packages/debian_repository/index.md) -for more information about working with Debian packages. +This is the reference documentation for the Debian group distributions API. This API is behind a +feature flag that is disabled by default. To use this API, you must [enable it](#enable-the-debian-group-api). -## Enable Debian repository feature +WARNING: +This API is under development and is not meant for production use. -Debian repository support is gated behind a feature flag that is **disabled by default**. -[GitLab administrators with access to the GitLab Rails console](../../administration/feature_flags.md) -can opt to enable it. - -To enable it: - -```ruby -Feature.enable(:debian_packages) -``` +For more information about working with Debian packages, see the +[Debian package registry documentation](../../user/packages/debian_repository/index.md). -To disable it: +## Enable the Debian group API -```ruby -Feature.disable(:debian_packages) -``` +Debian group repository support is still a work in progress. It's gated behind a feature flag that's +**disabled by default**. +[GitLab administrators with access to the GitLab Rails console](../../administration/feature_flags.md) +can opt to enable it. To enable it, follow the instructions in +[Enable the Debian group API](../../user/packages/debian_repository/index.md#enable-the-debian-group-api). ## List all Debian distributions in a group diff --git a/doc/api/packages/debian_project_distributions.md b/doc/api/packages/debian_project_distributions.md index aad5558dcba..bedf3f1f27a 100644 --- a/doc/api/packages/debian_project_distributions.md +++ b/doc/api/packages/debian_project_distributions.md @@ -4,30 +4,26 @@ group: Package info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Debian project distributions API **(FREE)** +# Debian project distributions API **(FREE SELF)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/5835) in GitLab 14.0. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/42670) in GitLab 13.5. +> - [Deployed behind a feature flag](../../user/feature_flags.md), disabled by default. -See the [Debian package registry documentation](../../user/packages/debian_repository/index.md) -for more information about working with Debian packages. +This is the reference documentation for the Debian project distributions API. This API is behind a +feature flag that is disabled by default. To use this API, you must [enable the Debian API](#enable-the-debian-api). -## Enable Debian repository feature +WARNING: +This API is under development and is not meant for production use. -Debian repository support is gated behind a feature flag that is **disabled by default**. -[GitLab administrators with access to the GitLab Rails console](../../administration/feature_flags.md) -can opt to enable it. - -To enable it: - -```ruby -Feature.enable(:debian_packages) -``` +For more information about working with Debian packages, see the +[Debian package registry documentation](../../user/packages/debian_repository/index.md). -To disable it: +## Enable the Debian API -```ruby -Feature.disable(:debian_packages) -``` +The Debian API is behind a feature flag that is disabled by default. +[GitLab administrators with access to the GitLab Rails console](../../administration/feature_flags.md) +can opt to enable it. To enable it, follow the instructions in +[Enable the Debian API](../../user/packages/debian_repository/index.md#enable-the-debian-api). ## List all Debian distributions in a project diff --git a/doc/api/packages/helm.md b/doc/api/packages/helm.md index a76fa9d3755..f1d5f24cd99 100644 --- a/doc/api/packages/helm.md +++ b/doc/api/packages/helm.md @@ -11,8 +11,7 @@ This is the API documentation for [Helm](../../user/packages/helm_repository/ind WARNING: This API is used by the Helm-related package clients such as [Helm](https://helm.sh/) and [`helm-push`](https://github.com/chartmuseum/helm-push/#readme), -and is generally not meant for manual consumption. This API is under development and is not ready -for production use due to limited functionality. +and is generally not meant for manual consumption. For instructions on how to upload and install Helm packages from the GitLab Package Registry, see the [Helm registry documentation](../../user/packages/helm_repository/index.md). -- cgit v1.2.3