From 9c4a4345cb2c83995a5c7f72cc2f04a0d8847115 Mon Sep 17 00:00:00 2001 From: Ilya Khandamirov Date: Fri, 6 Sep 2024 11:17:23 +0200 Subject: [PATCH 01/38] examples credentials ocmconfig --- content/docs/examples/creds-in-ocmconfig.md | 134 ++++++++++++++++++++ 1 file changed, 134 insertions(+) create mode 100644 content/docs/examples/creds-in-ocmconfig.md diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md new file mode 100644 index 00000000..bfea3db1 --- /dev/null +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -0,0 +1,134 @@ +--- +title: "Credentials in ocmconfig file" +description: "" +summary: "" +date: 2024-09-04T13:54:01+02:00 +lastmod: 2024-09-04T13:54:01+02:00 +draft: false +weight: 999 +toc: true +--- + +## Overview + +The [OCM command line client](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm.md) can be configured by supplying it with a [configuration file](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_configfile.md). By default, the CLI looks for configuration in `$HOME/.ocmconfig`, if it exists. + +The configuration file can be used in particular to specify the credentials, which are required for the CLI to be able to access the artifact repositories, referenced in CLI commands. + +## Examples + +This page contains basic examples of configuration for a few most common artifact repository types. The examples below are complete `.ocmconfig` files, not snippets. + +For comprehensive documentation on the credentials topic, including usage of certificates or HashiCorp Vault, execute the command `ocm credential-handling`. + +### Repositories and Consumers + +In the examples below some configuration is located under `configurations[0]`.`repositories`, and some other under `configurations[0]`.`consumers`. This chanpter explains the difference between `repositories` and `consumers`, which is potentially not as obvious as one could think. + +In this context, `repository` is a place, where credentials can be stored, i.e. it is a credentials repository. For example, Docker's `config.json` can store multiple credentials, and in that sense the file serves as a repository that can store and provide credentials. That is why its location is configured under `repositories`. Other examples of credentials repositories can be the NPM's `.npmrc` file or a HashiCorp Vault instance. + +A `consumer` is something the credentials are required for. For example, if you need to configure credentials that are required to log in to an OCI registry, one could say that the registry will be consuming these credentials, i.e. the registry is a credentials consumer. That is why it is configured under `consumers`. + +### Re-use credentials configured for Docker + +This `.ocmconfig` file will tell OCM CLI to use configuration from Docker's `config.json`. + +```yaml +type: generic.config.ocm.software/v1 +configurations: + - type: credentials.config.ocm.software + repositories: + - repository: + type: DockerConfig/v1 + dockerConfigFile: "~/.docker/config.json" + propagateConsumerIdentity: true +``` + +### Accessing OCI registries + +#### HTTPS and path + +To access artifacts in `https://ghcr.io/mandelsoft`: +* Omit the protocol +* The path behind the top-level domain hast to be specified in a separate `pathprefix` field + +```yaml +type: generic.config.ocm.software/v1 +configurations: + - type: credentials.config.ocm.software + consumers: + - identity: + type: OCIRegistry + hostname: ghcr.io + pathprefix: mandelsoft + credentials: + - type: Credentials + properties: + username: some-user + password: some-token +``` + +#### HTTP, port number, empty path + +To access artifacts in `http://127.0.0.1:5001`: +* Omit the protocol +* Omit the port number +* As the URL has no path behind the port number, `pathprefix` element can be removed or left empty + +```yaml +type: generic.config.ocm.software/v1 +configurations: + - type: credentials.config.ocm.software + consumers: + - identity: + type: OCIRegistry + hostname: 127.0.0.1 + credentials: + - type: Credentials + properties: + username: admin + password: admin +``` + +### Accessing Helm chart repositories + +Similar to OCI registries, but use `HelmChartRepository` as identity type. + +```yaml +type: generic.config.ocm.software/v1 +configurations: + - type: credentials.config.ocm.software + consumers: + - identity: + type: HelmChartRepository + hostname: ghcr.io + pathprefix: mandelsoft + credentials: + - type: Credentials + properties: + username: some-user + password: some-token +``` + +### Accessing GitHub repositories + +To access code in `https://my.github.enterprise/my-org/my-repo`: +* Use `Github` as identity type +* `hostname` is the domain name of the GitHub instance +* `pathname` is a combination of organization and repository names +* `token` is a personal access token generated in GitHub Developer Settings + +```yaml +type: generic.config.ocm.software/v1 +configurations: + - type: credentials.config.ocm.software + consumers: + - identity: + type: Github + hostname: my.github.enterprise + pathprefix: my-org/my-repo + credentials: + - type: Credentials + properties: + token: ghp_my_personal_access_token +``` From e64274feaac1c3cad43c5d04c21fadb0881859ba Mon Sep 17 00:00:00 2001 From: Ilya Khandamirov Date: Fri, 6 Sep 2024 11:29:44 +0200 Subject: [PATCH 02/38] update --- content/docs/examples/creds-in-ocmconfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index bfea3db1..53a01adb 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -17,7 +17,7 @@ The configuration file can be used in particular to specify the credentials, whi ## Examples -This page contains basic examples of configuration for a few most common artifact repository types. The examples below are complete `.ocmconfig` files, not snippets. +This page contains basic examples of credentials configuration for a few most common artifact repository types. The examples below are complete `.ocmconfig` files, not snippets. For comprehensive documentation on the credentials topic, including usage of certificates or HashiCorp Vault, execute the command `ocm credential-handling`. From f312f6cf224d137381c2e3fc1dad9f5da351819b Mon Sep 17 00:00:00 2001 From: Ilya Khandamirov Date: Mon, 9 Sep 2024 17:45:07 +0200 Subject: [PATCH 03/38] accessing several systems --- content/docs/examples/creds-in-ocmconfig.md | 35 +++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 53a01adb..c3958cde 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -132,3 +132,38 @@ configurations: properties: token: ghp_my_personal_access_token ``` + +### Accessing several systems + +It is, of course, possible to configure credentials for several systems in the same `.ocmconfig` file. To do that, you can combine as many repositories and consumers as you need. + +The example below instructs OCM CLI to look for credentials in Docker's `config.json`, and in addition specifies dedicated credentials for an OCI registry and a GitHub repository. + +```yaml +type: generic.config.ocm.software/v1 +configurations: + - type: credentials.config.ocm.software + repositories: + - repository: + type: DockerConfig/v1 + dockerConfigFile: "~/.docker/config.json" + propagateConsumerIdentity: true + consumers: + - identity: + type: OCIRegistry + hostname: ghcr.io + pathprefix: mandelsoft + credentials: + - type: Credentials + properties: + username: some-user + password: some-token + - identity: + type: Github + hostname: my.github.enterprise + pathprefix: my-org/my-repo + credentials: + - type: Credentials + properties: + token: ghp_my_personal_access_token +``` From 430023e41ac54a793c9620ed164426c0dbc46fce Mon Sep 17 00:00:00 2001 From: ikhandamirov <108289993+ikhandamirov@users.noreply.github.com> Date: Tue, 10 Sep 2024 10:20:18 +0200 Subject: [PATCH 04/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com> --- content/docs/examples/creds-in-ocmconfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index c3958cde..b082e20b 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -48,7 +48,7 @@ configurations: #### HTTPS and path -To access artifacts in `https://ghcr.io/mandelsoft`: +To access artifacts in `https://ghcr.io/open-component-model`: * Omit the protocol * The path behind the top-level domain hast to be specified in a separate `pathprefix` field From 7252cb7142903da7eb19e91b917f32a48a7010f0 Mon Sep 17 00:00:00 2001 From: ikhandamirov <108289993+ikhandamirov@users.noreply.github.com> Date: Tue, 10 Sep 2024 10:20:37 +0200 Subject: [PATCH 05/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com> --- content/docs/examples/creds-in-ocmconfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index b082e20b..1c046ae7 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -60,7 +60,7 @@ configurations: - identity: type: OCIRegistry hostname: ghcr.io - pathprefix: mandelsoft + pathprefix: open-component-model credentials: - type: Credentials properties: From d69630484e1f27148303166499dd354674ecc613 Mon Sep 17 00:00:00 2001 From: ikhandamirov <108289993+ikhandamirov@users.noreply.github.com> Date: Tue, 10 Sep 2024 10:20:59 +0200 Subject: [PATCH 06/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com> --- content/docs/examples/creds-in-ocmconfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 1c046ae7..424d8487 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -102,7 +102,7 @@ configurations: - identity: type: HelmChartRepository hostname: ghcr.io - pathprefix: mandelsoft + pathprefix: open-component-model credentials: - type: Credentials properties: From cb47a79ef3a15f8643f74b4dc14269a0dedca4f0 Mon Sep 17 00:00:00 2001 From: ikhandamirov <108289993+ikhandamirov@users.noreply.github.com> Date: Tue, 10 Sep 2024 10:21:19 +0200 Subject: [PATCH 07/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Gerald Morrison <67469729+morri-son@users.noreply.github.com> --- content/docs/examples/creds-in-ocmconfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 424d8487..9068353b 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -152,7 +152,7 @@ configurations: - identity: type: OCIRegistry hostname: ghcr.io - pathprefix: mandelsoft + pathprefix: open-component-model credentials: - type: Credentials properties: From 7eb3ca46e67fb8723abd1473566fb139b6254b28 Mon Sep 17 00:00:00 2001 From: Ilya Khandamirov Date: Tue, 10 Sep 2024 10:57:41 +0200 Subject: [PATCH 08/38] `password` better explained --- content/docs/examples/creds-in-ocmconfig.md | 1 + 1 file changed, 1 insertion(+) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 9068353b..15e35e63 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -51,6 +51,7 @@ configurations: To access artifacts in `https://ghcr.io/open-component-model`: * Omit the protocol * The path behind the top-level domain hast to be specified in a separate `pathprefix` field +* The `password` is the user's basic authentication password. Some OCI registries allow to generate user access tokens, which can also be used for basic authentication. ```yaml type: generic.config.ocm.software/v1 From 68ce05ca3ffbdabe915b247461a3a6afcb3377d0 Mon Sep 17 00:00:00 2001 From: Ilya Khandamirov Date: Thu, 12 Sep 2024 14:31:31 +0200 Subject: [PATCH 09/38] npm and maven --- content/docs/examples/creds-in-ocmconfig.md | 59 ++++++++++++++++++++- 1 file changed, 57 insertions(+), 2 deletions(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 15e35e63..bae6fa4a 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -31,7 +31,7 @@ A `consumer` is something the credentials are required for. For example, if you ### Re-use credentials configured for Docker -This `.ocmconfig` file will tell OCM CLI to use configuration from Docker's `config.json`. +This `.ocmconfig` file will tell OCM CLI to use credentials configuration from Docker's `config.json` file. ```yaml type: generic.config.ocm.software/v1 @@ -44,6 +44,20 @@ configurations: propagateConsumerIdentity: true ``` +### Re-use credentials configured for npm + +This `.ocmconfig` file will tell OCM CLI to use credentials configuration from npm's `.npmrc` file. + +```yaml +type: generic.config.ocm.software/v1 +configurations: + - type: credentials.config.ocm.software + repositories: + - repository: + type: NPMConfig/v1 + npmrcFile: '~/.npmrc' +``` + ### Accessing OCI registries #### HTTPS and path @@ -111,12 +125,53 @@ configurations: password: some-token ``` +### Accessing Maven repositories + +Similar to OCI registries, but use `MavenRepository` as identity type. + +```yaml +type: generic.config.ocm.software/v1 +configurations: + - type: credentials.config.ocm.software + consumers: + - identity: + type: MavenRepository + hostname: maven.repo.host + pathprefix: path/to/repo + credentials: + - type: Credentials + properties: + username: some-user + password: some-password +``` + +### Accessing npm registries + +Similar to OCI registries, but use `NpmRegistry` as identity type. In addition, it is required to specify the `email` address matching with the one in the user record in the npm registry. + +```yaml +type: generic.config.ocm.software/v1 +configurations: + - type: credentials.config.ocm.software + consumers: + - identity: + type: NpmRegistry + hostname: npm.registry.host + pathprefix: path/to/registry + credentials: + - type: Credentials + properties: + username: some-user + password: some-password + email: foo.bar@acme.org +``` + ### Accessing GitHub repositories To access code in `https://my.github.enterprise/my-org/my-repo`: * Use `Github` as identity type * `hostname` is the domain name of the GitHub instance -* `pathname` is a combination of organization and repository names +* `pathprefix` is a combination of organization and repository names * `token` is a personal access token generated in GitHub Developer Settings ```yaml From 7aa57c4c19d0dc1a16fe260500c38525c0915b01 Mon Sep 17 00:00:00 2001 From: ikhandamirov <108289993+ikhandamirov@users.noreply.github.com> Date: Fri, 13 Sep 2024 11:00:21 +0200 Subject: [PATCH 10/38] chapter Co-authored-by: Frederic Wilhelm --- content/docs/examples/creds-in-ocmconfig.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index bae6fa4a..05d495b7 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -23,7 +23,8 @@ For comprehensive documentation on the credentials topic, including usage of cer ### Repositories and Consumers -In the examples below some configuration is located under `configurations[0]`.`repositories`, and some other under `configurations[0]`.`consumers`. This chanpter explains the difference between `repositories` and `consumers`, which is potentially not as obvious as one could think. +In the examples below some configuration is located under `configurations[0]`.`repositories`, and some other under `configurations[0]`.`consumers`. This chapter explains the difference between `repositories` and `consumers`, which is potentially not as obvious as one could think. + In this context, `repository` is a place, where credentials can be stored, i.e. it is a credentials repository. For example, Docker's `config.json` can store multiple credentials, and in that sense the file serves as a repository that can store and provide credentials. That is why its location is configured under `repositories`. Other examples of credentials repositories can be the NPM's `.npmrc` file or a HashiCorp Vault instance. From 79ec4b0674129767950493a255bfa8db43936db0 Mon Sep 17 00:00:00 2001 From: ikhandamirov <108289993+ikhandamirov@users.noreply.github.com> Date: Fri, 13 Sep 2024 11:02:20 +0200 Subject: [PATCH 11/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Fabian Burth --- content/docs/examples/creds-in-ocmconfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 05d495b7..9d305ff9 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -32,7 +32,7 @@ A `consumer` is something the credentials are required for. For example, if you ### Re-use credentials configured for Docker -This `.ocmconfig` file will tell OCM CLI to use credentials configuration from Docker's `config.json` file. +This `.ocmconfig` file will tell the OCM CLI to use credentials configuration from Docker's `config.json` file. ```yaml type: generic.config.ocm.software/v1 From ed9a172a9d697193718d725cca56d092265449a9 Mon Sep 17 00:00:00 2001 From: ikhandamirov <108289993+ikhandamirov@users.noreply.github.com> Date: Fri, 13 Sep 2024 12:17:46 +0200 Subject: [PATCH 12/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Fabian Burth --- content/docs/examples/creds-in-ocmconfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 9d305ff9..242777b3 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -65,7 +65,7 @@ configurations: To access artifacts in `https://ghcr.io/open-component-model`: * Omit the protocol -* The path behind the top-level domain hast to be specified in a separate `pathprefix` field +* The path behind the top-level domain has to be specified in a separate `pathprefix` field * The `password` is the user's basic authentication password. Some OCI registries allow to generate user access tokens, which can also be used for basic authentication. ```yaml From c0de841b9cd15c533f133b4d9d8706d838b5e410 Mon Sep 17 00:00:00 2001 From: ikhandamirov <108289993+ikhandamirov@users.noreply.github.com> Date: Fri, 13 Sep 2024 12:45:21 +0200 Subject: [PATCH 13/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Fabian Burth --- content/docs/examples/creds-in-ocmconfig.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 242777b3..083e0ea6 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -42,7 +42,6 @@ configurations: - repository: type: DockerConfig/v1 dockerConfigFile: "~/.docker/config.json" - propagateConsumerIdentity: true ``` ### Re-use credentials configured for npm From 5b34d95f0fdd17ec108a0f684139220b93b1fab5 Mon Sep 17 00:00:00 2001 From: Ilya Khandamirov Date: Fri, 13 Sep 2024 14:22:42 +0200 Subject: [PATCH 14/38] oci registries re-worked --- content/docs/examples/creds-in-ocmconfig.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 083e0ea6..03815ffc 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -63,8 +63,8 @@ configurations: #### HTTPS and path To access artifacts in `https://ghcr.io/open-component-model`: -* Omit the protocol -* The path behind the top-level domain has to be specified in a separate `pathprefix` field +* The different parts of the URL have to be specified in separate fields: `scheme`, `hostname` and `pathprefix` +* The fields `scheme` and `pathprefix` are optional. If not specified, the OCM CLI will use the credentials for all schemes and paths on that host * The `password` is the user's basic authentication password. Some OCI registries allow to generate user access tokens, which can also be used for basic authentication. ```yaml @@ -74,6 +74,7 @@ configurations: consumers: - identity: type: OCIRegistry + scheme: https hostname: ghcr.io pathprefix: open-component-model credentials: @@ -86,9 +87,9 @@ configurations: #### HTTP, port number, empty path To access artifacts in `http://127.0.0.1:5001`: -* Omit the protocol -* Omit the port number -* As the URL has no path behind the port number, `pathprefix` element can be removed or left empty +* Note the quotes around the `port` number +* The fields `scheme` and `port` are optional. If not specified, the OCM CLI will use the credentials for all schemes and ports on that host +* As the URL has no path behind the port number, `pathprefix` element can be removed ```yaml type: generic.config.ocm.software/v1 @@ -97,7 +98,9 @@ configurations: consumers: - identity: type: OCIRegistry + scheme: http hostname: 127.0.0.1 + port: "5001" credentials: - type: Credentials properties: From 995822b9ef1ab6791fd4f690293600039cad23ca Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:09:16 +0200 Subject: [PATCH 15/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Nikolay Boshnakov --- content/docs/examples/creds-in-ocmconfig.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 03815ffc..7aca342b 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -13,7 +13,8 @@ toc: true The [OCM command line client](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm.md) can be configured by supplying it with a [configuration file](https://github.com/open-component-model/ocm/blob/main/docs/reference/ocm_configfile.md). By default, the CLI looks for configuration in `$HOME/.ocmconfig`, if it exists. -The configuration file can be used in particular to specify the credentials, which are required for the CLI to be able to access the artifact repositories, referenced in CLI commands. +The configuration file can be used in particular to specify the credentials, which are required for the CLI to be able to access the artifact repositories referenced in CLI commands. + ## Examples From 2d2c2421d0e464c0d5b465654e847505ebe9eda5 Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:09:38 +0200 Subject: [PATCH 16/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Nikolay Boshnakov --- content/docs/examples/creds-in-ocmconfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 7aca342b..3d5d21d7 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -24,7 +24,7 @@ For comprehensive documentation on the credentials topic, including usage of cer ### Repositories and Consumers -In the examples below some configuration is located under `configurations[0]`.`repositories`, and some other under `configurations[0]`.`consumers`. This chapter explains the difference between `repositories` and `consumers`, which is potentially not as obvious as one could think. +In the examples below, some configuration is located under `configurations[0]`.`repositories`, and some other under `configurations[0]`.`consumers`. This chapter explains the difference between `repositories` and `consumers`, which is potentially not as obvious as one could think. In this context, `repository` is a place, where credentials can be stored, i.e. it is a credentials repository. For example, Docker's `config.json` can store multiple credentials, and in that sense the file serves as a repository that can store and provide credentials. That is why its location is configured under `repositories`. Other examples of credentials repositories can be the NPM's `.npmrc` file or a HashiCorp Vault instance. From ace4926da0b6bf769fe9dcc524e146b0d48163ca Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:10:03 +0200 Subject: [PATCH 17/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Nikolay Boshnakov --- content/docs/examples/creds-in-ocmconfig.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 3d5d21d7..4cf13b8d 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -26,8 +26,8 @@ For comprehensive documentation on the credentials topic, including usage of cer In the examples below, some configuration is located under `configurations[0]`.`repositories`, and some other under `configurations[0]`.`consumers`. This chapter explains the difference between `repositories` and `consumers`, which is potentially not as obvious as one could think. +In this context, `repository` is a place where credentials can be stored, i.e., it is a credentials repository. For example, Docker's `config.json` can store multiple credentials, and in that sense the file serves as a repository that can store and provide credentials. That is why its location is configured under `repositories`. Other examples of credentials repositories can be the NPM's `.npmrc` file or a HashiCorp Vault instance. -In this context, `repository` is a place, where credentials can be stored, i.e. it is a credentials repository. For example, Docker's `config.json` can store multiple credentials, and in that sense the file serves as a repository that can store and provide credentials. That is why its location is configured under `repositories`. Other examples of credentials repositories can be the NPM's `.npmrc` file or a HashiCorp Vault instance. A `consumer` is something the credentials are required for. For example, if you need to configure credentials that are required to log in to an OCI registry, one could say that the registry will be consuming these credentials, i.e. the registry is a credentials consumer. That is why it is configured under `consumers`. From 3709e121ba5f88a23e2aa2f9a8b001acc337666d Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:10:13 +0200 Subject: [PATCH 18/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Nikolay Boshnakov --- content/docs/examples/creds-in-ocmconfig.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 4cf13b8d..06237851 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -29,7 +29,8 @@ In the examples below, some configuration is located under `configurations[0]`.` In this context, `repository` is a place where credentials can be stored, i.e., it is a credentials repository. For example, Docker's `config.json` can store multiple credentials, and in that sense the file serves as a repository that can store and provide credentials. That is why its location is configured under `repositories`. Other examples of credentials repositories can be the NPM's `.npmrc` file or a HashiCorp Vault instance. -A `consumer` is something the credentials are required for. For example, if you need to configure credentials that are required to log in to an OCI registry, one could say that the registry will be consuming these credentials, i.e. the registry is a credentials consumer. That is why it is configured under `consumers`. +A `consumer` is something the credentials are required for. For example, if you need to configure credentials that are required to log in to an OCI registry, one could say that the registry will be consuming these credentials, i.e., the registry is a credentials consumer. That is why it is configured under `consumers`. + ### Re-use credentials configured for Docker From 85d0e44f302b156377eb77297c50b3b028318812 Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:10:27 +0200 Subject: [PATCH 19/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Nikolay Boshnakov --- content/docs/examples/creds-in-ocmconfig.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 06237851..7aaff95d 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -32,7 +32,8 @@ In this context, `repository` is a place where credentials can be stored, i.e., A `consumer` is something the credentials are required for. For example, if you need to configure credentials that are required to log in to an OCI registry, one could say that the registry will be consuming these credentials, i.e., the registry is a credentials consumer. That is why it is configured under `consumers`. -### Re-use credentials configured for Docker +### Reuse Credentials Configured for Docker + This `.ocmconfig` file will tell the OCM CLI to use credentials configuration from Docker's `config.json` file. From 72d133e495dee273a83f9107b8bcb1ecba38c49b Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:10:39 +0200 Subject: [PATCH 20/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Nikolay Boshnakov --- content/docs/examples/creds-in-ocmconfig.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 7aaff95d..4676e7d0 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -131,7 +131,8 @@ configurations: password: some-token ``` -### Accessing Maven repositories +### Accessing Maven Repositories + Similar to OCI registries, but use `MavenRepository` as identity type. From 03034b697e363c5f07db30e29bf82023919a7645 Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:10:51 +0200 Subject: [PATCH 21/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Nikolay Boshnakov --- content/docs/examples/creds-in-ocmconfig.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 4676e7d0..9f9ec9d1 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -152,7 +152,8 @@ configurations: password: some-password ``` -### Accessing npm registries +### Accessing npm Registries + Similar to OCI registries, but use `NpmRegistry` as identity type. In addition, it is required to specify the `email` address matching with the one in the user record in the npm registry. From 02f957549b7eb92038e9410f97bc643fdd214f5c Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:10:57 +0200 Subject: [PATCH 22/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Nikolay Boshnakov --- content/docs/examples/creds-in-ocmconfig.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 9f9ec9d1..f6bd80fc 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -174,7 +174,8 @@ configurations: email: foo.bar@acme.org ``` -### Accessing GitHub repositories +### Accessing GitHub Repositories + To access code in `https://my.github.enterprise/my-org/my-repo`: * Use `Github` as identity type From 8f398a2f3011a368d2cc9621a74cc3cdae1cb61b Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:11:03 +0200 Subject: [PATCH 23/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Nikolay Boshnakov --- content/docs/examples/creds-in-ocmconfig.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index f6bd80fc..e30cff12 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -1,5 +1,6 @@ --- -title: "Credentials in ocmconfig file" +title: "Credentials in an ocmconfig file" + description: "" summary: "" date: 2024-09-04T13:54:01+02:00 From c0830804a82ef83f5d7e0fb2d471a7270f286eca Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:11:12 +0200 Subject: [PATCH 24/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Nikolay Boshnakov --- content/docs/examples/creds-in-ocmconfig.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index e30cff12..c85dcf97 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -199,7 +199,8 @@ configurations: token: ghp_my_personal_access_token ``` -### Accessing several systems +### Accessing Several Systems + It is, of course, possible to configure credentials for several systems in the same `.ocmconfig` file. To do that, you can combine as many repositories and consumers as you need. From f34cf28421cb77aeb0cb9c097620a5be8f4d8aec Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:13:29 +0200 Subject: [PATCH 25/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Nikolay Boshnakov --- content/docs/examples/creds-in-ocmconfig.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index c85dcf97..898d9062 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -62,7 +62,8 @@ configurations: npmrcFile: '~/.npmrc' ``` -### Accessing OCI registries +### Accessing OCI Registries + #### HTTPS and path From 1c1c950b96ef74ceb3eee3065909414c72bc4ffc Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:13:36 +0200 Subject: [PATCH 26/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Nikolay Boshnakov --- content/docs/examples/creds-in-ocmconfig.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 898d9062..59fad5a9 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -48,7 +48,8 @@ configurations: dockerConfigFile: "~/.docker/config.json" ``` -### Re-use credentials configured for npm +### Reuse Credentials Configured for npm + This `.ocmconfig` file will tell OCM CLI to use credentials configuration from npm's `.npmrc` file. From eb490ff1ffb26af920e622b5adb308aaa9fefa6b Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:13:44 +0200 Subject: [PATCH 27/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Nikolay Boshnakov --- content/docs/examples/creds-in-ocmconfig.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 59fad5a9..6858c9b1 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -66,7 +66,8 @@ configurations: ### Accessing OCI Registries -#### HTTPS and path +#### HTTPS and Path + To access artifacts in `https://ghcr.io/open-component-model`: * The different parts of the URL have to be specified in separate fields: `scheme`, `hostname` and `pathprefix` From 6224a959e2d5b4ea5e3468a50f9d648d2a690b61 Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:14:13 +0200 Subject: [PATCH 28/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Nikolay Boshnakov --- content/docs/examples/creds-in-ocmconfig.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 6858c9b1..6a3d8953 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -70,9 +70,10 @@ configurations: To access artifacts in `https://ghcr.io/open-component-model`: -* The different parts of the URL have to be specified in separate fields: `scheme`, `hostname` and `pathprefix` +* The different parts of the URL have to be specified in separate fields: `scheme`, `hostname`, and `pathprefix` * The fields `scheme` and `pathprefix` are optional. If not specified, the OCM CLI will use the credentials for all schemes and paths on that host -* The `password` is the user's basic authentication password. Some OCI registries allow to generate user access tokens, which can also be used for basic authentication. +* The `password` is the user's basic authentication password. Some OCI registries allow to generate user access tokens, which can also be used for basic authentication + ```yaml type: generic.config.ocm.software/v1 From 1d99d7c5e024848826004fa6745ecb5622629b48 Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:14:23 +0200 Subject: [PATCH 29/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Nikolay Boshnakov --- content/docs/examples/creds-in-ocmconfig.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 6a3d8953..06e1d460 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -92,7 +92,8 @@ configurations: password: some-token ``` -#### HTTP, port number, empty path +#### HTTP, Port Number, Empty Path + To access artifacts in `http://127.0.0.1:5001`: * Note the quotes around the `port` number From fa98f36961b2e592f1dbf665501ca3be704b3d90 Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:14:35 +0200 Subject: [PATCH 30/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Nikolay Boshnakov --- content/docs/examples/creds-in-ocmconfig.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 06e1d460..f4268ec6 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -98,7 +98,8 @@ configurations: To access artifacts in `http://127.0.0.1:5001`: * Note the quotes around the `port` number * The fields `scheme` and `port` are optional. If not specified, the OCM CLI will use the credentials for all schemes and ports on that host -* As the URL has no path behind the port number, `pathprefix` element can be removed +* As the URL has no path behind the port number, the `pathprefix` element can be removed + ```yaml type: generic.config.ocm.software/v1 From d24b57012a08157d7e7345a4338031a83cd4eab7 Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:14:42 +0200 Subject: [PATCH 31/38] Update content/docs/examples/creds-in-ocmconfig.md Co-authored-by: Nikolay Boshnakov --- content/docs/examples/creds-in-ocmconfig.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index f4268ec6..5c126a31 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -118,7 +118,8 @@ configurations: password: admin ``` -### Accessing Helm chart repositories +### Accessing Helm Chart Repositories + Similar to OCI registries, but use `HelmChartRepository` as identity type. From d7ada21a6798a30fbaa6f58ed0d74e0faf3af49a Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:20:14 +0200 Subject: [PATCH 32/38] remove empty lines --- content/docs/examples/creds-in-ocmconfig.md | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 5c126a31..b34d4936 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -16,7 +16,6 @@ The [OCM command line client](https://github.com/open-component-model/ocm/blob/m The configuration file can be used in particular to specify the credentials, which are required for the CLI to be able to access the artifact repositories referenced in CLI commands. - ## Examples This page contains basic examples of credentials configuration for a few most common artifact repository types. The examples below are complete `.ocmconfig` files, not snippets. @@ -29,13 +28,10 @@ In the examples below, some configuration is located under `configurations[0]`.` In this context, `repository` is a place where credentials can be stored, i.e., it is a credentials repository. For example, Docker's `config.json` can store multiple credentials, and in that sense the file serves as a repository that can store and provide credentials. That is why its location is configured under `repositories`. Other examples of credentials repositories can be the NPM's `.npmrc` file or a HashiCorp Vault instance. - A `consumer` is something the credentials are required for. For example, if you need to configure credentials that are required to log in to an OCI registry, one could say that the registry will be consuming these credentials, i.e., the registry is a credentials consumer. That is why it is configured under `consumers`. - ### Reuse Credentials Configured for Docker - This `.ocmconfig` file will tell the OCM CLI to use credentials configuration from Docker's `config.json` file. ```yaml @@ -50,7 +46,6 @@ configurations: ### Reuse Credentials Configured for npm - This `.ocmconfig` file will tell OCM CLI to use credentials configuration from npm's `.npmrc` file. ```yaml @@ -65,16 +60,13 @@ configurations: ### Accessing OCI Registries - #### HTTPS and Path - To access artifacts in `https://ghcr.io/open-component-model`: * The different parts of the URL have to be specified in separate fields: `scheme`, `hostname`, and `pathprefix` * The fields `scheme` and `pathprefix` are optional. If not specified, the OCM CLI will use the credentials for all schemes and paths on that host * The `password` is the user's basic authentication password. Some OCI registries allow to generate user access tokens, which can also be used for basic authentication - ```yaml type: generic.config.ocm.software/v1 configurations: @@ -94,13 +86,11 @@ configurations: #### HTTP, Port Number, Empty Path - To access artifacts in `http://127.0.0.1:5001`: * Note the quotes around the `port` number * The fields `scheme` and `port` are optional. If not specified, the OCM CLI will use the credentials for all schemes and ports on that host * As the URL has no path behind the port number, the `pathprefix` element can be removed - ```yaml type: generic.config.ocm.software/v1 configurations: @@ -120,7 +110,6 @@ configurations: ### Accessing Helm Chart Repositories - Similar to OCI registries, but use `HelmChartRepository` as identity type. ```yaml @@ -141,7 +130,6 @@ configurations: ### Accessing Maven Repositories - Similar to OCI registries, but use `MavenRepository` as identity type. ```yaml @@ -162,7 +150,6 @@ configurations: ### Accessing npm Registries - Similar to OCI registries, but use `NpmRegistry` as identity type. In addition, it is required to specify the `email` address matching with the one in the user record in the npm registry. ```yaml @@ -184,7 +171,6 @@ configurations: ### Accessing GitHub Repositories - To access code in `https://my.github.enterprise/my-org/my-repo`: * Use `Github` as identity type * `hostname` is the domain name of the GitHub instance @@ -208,7 +194,6 @@ configurations: ### Accessing Several Systems - It is, of course, possible to configure credentials for several systems in the same `.ocmconfig` file. To do that, you can combine as many repositories and consumers as you need. The example below instructs OCM CLI to look for credentials in Docker's `config.json`, and in addition specifies dedicated credentials for an OCI registry and a GitHub repository. From da44ff0b877fc9eeddf6fb6388afe1b3673d6e02 Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:22:29 +0200 Subject: [PATCH 33/38] Update creds-in-ocmconfig.md --- content/docs/examples/creds-in-ocmconfig.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index b34d4936..cbfccb74 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -1,6 +1,5 @@ --- title: "Credentials in an ocmconfig file" - description: "" summary: "" date: 2024-09-04T13:54:01+02:00 From d8875bf5845e0384bf09e43926436e49a5538d66 Mon Sep 17 00:00:00 2001 From: Gerald Morrison <67469729+morri-son@users.noreply.github.com> Date: Mon, 16 Sep 2024 12:28:47 +0200 Subject: [PATCH 34/38] Update creds-in-ocmconfig.md --- content/docs/examples/creds-in-ocmconfig.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index cbfccb74..ccc1f604 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -109,7 +109,7 @@ configurations: ### Accessing Helm Chart Repositories -Similar to OCI registries, but use `HelmChartRepository` as identity type. +Similar to OCI registries, but uses `HelmChartRepository` as identity type. ```yaml type: generic.config.ocm.software/v1 @@ -129,7 +129,7 @@ configurations: ### Accessing Maven Repositories -Similar to OCI registries, but use `MavenRepository` as identity type. +Similar to OCI registries, but uses `MavenRepository` as identity type. ```yaml type: generic.config.ocm.software/v1 @@ -149,7 +149,7 @@ configurations: ### Accessing npm Registries -Similar to OCI registries, but use `NpmRegistry` as identity type. In addition, it is required to specify the `email` address matching with the one in the user record in the npm registry. +Similar to OCI registries, but uses `NpmRegistry` as identity type. In addition, it is required to specify the `email` address matching with the one in the user record in the npm registry. ```yaml type: generic.config.ocm.software/v1 From 7c9771283f2da5138890dce4bf6ee8e21e426621 Mon Sep 17 00:00:00 2001 From: Ilya Khandamirov Date: Mon, 16 Sep 2024 12:57:43 +0200 Subject: [PATCH 35/38] blank line before lists --- content/docs/examples/creds-in-ocmconfig.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index ccc1f604..274f82dc 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -62,6 +62,7 @@ configurations: #### HTTPS and Path To access artifacts in `https://ghcr.io/open-component-model`: + * The different parts of the URL have to be specified in separate fields: `scheme`, `hostname`, and `pathprefix` * The fields `scheme` and `pathprefix` are optional. If not specified, the OCM CLI will use the credentials for all schemes and paths on that host * The `password` is the user's basic authentication password. Some OCI registries allow to generate user access tokens, which can also be used for basic authentication @@ -86,6 +87,7 @@ configurations: #### HTTP, Port Number, Empty Path To access artifacts in `http://127.0.0.1:5001`: + * Note the quotes around the `port` number * The fields `scheme` and `port` are optional. If not specified, the OCM CLI will use the credentials for all schemes and ports on that host * As the URL has no path behind the port number, the `pathprefix` element can be removed @@ -171,6 +173,7 @@ configurations: ### Accessing GitHub Repositories To access code in `https://my.github.enterprise/my-org/my-repo`: + * Use `Github` as identity type * `hostname` is the domain name of the GitHub instance * `pathprefix` is a combination of organization and repository names From 57528ceaa5b74f850d7578e55ade8492e7fc6e68 Mon Sep 17 00:00:00 2001 From: Ilya Khandamirov Date: Mon, 16 Sep 2024 13:03:01 +0200 Subject: [PATCH 36/38] exceptions for spell checker --- .github/config/wordlist.txt | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/config/wordlist.txt b/.github/config/wordlist.txt index c58e624f..e66c5241 100644 --- a/.github/config/wordlist.txt +++ b/.github/config/wordlist.txt @@ -70,6 +70,7 @@ digesters directorytree dirtree dns +docker's dockerconfig downloadconstraint downloader @@ -148,6 +149,7 @@ kubebuilder kubeconfig kubernetes labelmergespecification +lastmod lifecycle linter linters @@ -181,6 +183,7 @@ newcomponentversionaccess newrepository newrepositoryspec npm +npm's npmjs npmrc npmregistry @@ -257,6 +260,7 @@ templaters templating tgz tls +toc todo toi toiexecutor From b657b738ec73d450286faed3523f8c5f89958af4 Mon Sep 17 00:00:00 2001 From: Ilya Khandamirov Date: Mon, 16 Sep 2024 16:01:15 +0200 Subject: [PATCH 37/38] port number w/o quotes --- content/docs/examples/creds-in-ocmconfig.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/docs/examples/creds-in-ocmconfig.md b/content/docs/examples/creds-in-ocmconfig.md index 274f82dc..e253ebe2 100644 --- a/content/docs/examples/creds-in-ocmconfig.md +++ b/content/docs/examples/creds-in-ocmconfig.md @@ -88,7 +88,6 @@ configurations: To access artifacts in `http://127.0.0.1:5001`: -* Note the quotes around the `port` number * The fields `scheme` and `port` are optional. If not specified, the OCM CLI will use the credentials for all schemes and ports on that host * As the URL has no path behind the port number, the `pathprefix` element can be removed @@ -101,7 +100,7 @@ configurations: type: OCIRegistry scheme: http hostname: 127.0.0.1 - port: "5001" + port: 5001 credentials: - type: Credentials properties: From 7cafcabf868e2e36ef2626d395c4e3fb8f38278f Mon Sep 17 00:00:00 2001 From: Ilya Khandamirov Date: Mon, 16 Sep 2024 16:16:40 +0200 Subject: [PATCH 38/38] sign empty commit