From 6339786ddc11ee8a2cffa3423b30fc54075ab0cd Mon Sep 17 00:00:00 2001 From: Sachin Date: Mon, 11 Nov 2024 16:22:59 +0530 Subject: [PATCH 1/2] Update Documentation for Artifactory Authentication Options Signed-off-by: Sachin --- content/reusable/md/policyfile_rb_settings.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/content/reusable/md/policyfile_rb_settings.md b/content/reusable/md/policyfile_rb_settings.md index 496982b6c7..d6e73676eb 100644 --- a/content/reusable/md/policyfile_rb_settings.md +++ b/content/reusable/md/policyfile_rb_settings.md @@ -26,8 +26,12 @@ A `Policyfile.rb` file may contain the following settings: - `:supermarket` `:artifactory` - : Pulls cookbooks from an Artifactory server. Requires either `artifactory_api_key` to be set in `config.rb` or - `ARTIFACTORY_API_KEY` to be set in your environment. + : Pulls cookbooks from an Artifactory server. + There are two ways to authenticate: + - **API Key**: Set `artifactory_api_key` in config.rb or use the environment variable `ARTIFACTORY_API_KEY`. + - **Identity Token** : Set `artifactory_identity_token` in config.rb or use the environment variable `ARTIFACTORY_IDENTITY_TOKEN`. + + **Note**: If both `ARTIFACTORY_API_KEY` and `ARTIFACTORY_IDENTITY_TOKEN` are set, `ARTIFACTORY_IDENTITY_TOKEN` will take precedence. For example, `default_source :artifactory, "https://artifactory.example/api/chef/my-supermarket"`. From 43d079587702357e7bb7fa70846058e7880b8c03 Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Mon, 18 Nov 2024 10:32:29 -0500 Subject: [PATCH 2/2] Edits Signed-off-by: Ian Maddaus --- content/config_rb_policyfile.md | 3 +-- content/reusable/md/policyfile_rb_settings.md | 14 +++++++++----- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/content/config_rb_policyfile.md b/content/config_rb_policyfile.md index 003eb63f2a..72269b7c25 100644 --- a/content/config_rb_policyfile.md +++ b/content/config_rb_policyfile.md @@ -19,8 +19,7 @@ product = ["client", "server"] {{< note >}} -For more information about Policyfile, see [About -Policyfile](/policyfile/) +For more information, see the [Policyfile documentation](/policyfile/). {{< /note >}} diff --git a/content/reusable/md/policyfile_rb_settings.md b/content/reusable/md/policyfile_rb_settings.md index d6e73676eb..ded1a20b31 100644 --- a/content/reusable/md/policyfile_rb_settings.md +++ b/content/reusable/md/policyfile_rb_settings.md @@ -27,14 +27,18 @@ A `Policyfile.rb` file may contain the following settings: `:artifactory` : Pulls cookbooks from an Artifactory server. - There are two ways to authenticate: - - **API Key**: Set `artifactory_api_key` in config.rb or use the environment variable `ARTIFACTORY_API_KEY`. - - **Identity Token** : Set `artifactory_identity_token` in config.rb or use the environment variable `ARTIFACTORY_IDENTITY_TOKEN`. - - **Note**: If both `ARTIFACTORY_API_KEY` and `ARTIFACTORY_IDENTITY_TOKEN` are set, `ARTIFACTORY_IDENTITY_TOKEN` will take precedence. For example, `default_source :artifactory, "https://artifactory.example/api/chef/my-supermarket"`. + There are two ways to authenticate with the Artifactory server: + + - **API key**: Set `artifactory_api_key` in config.rb or use the `ARTIFACTORY_API_KEY` environment variable. + - **Identity token**: Set `artifactory_identity_token` in config.rb or use the `ARTIFACTORY_IDENTITY_TOKEN` environment variable. + + The Artifactory identity token is new in Chef Workstation v24.11. + + **Note**: If both `ARTIFACTORY_API_KEY` and `ARTIFACTORY_IDENTITY_TOKEN` are set, `ARTIFACTORY_IDENTITY_TOKEN` takes precedence. + `:chef_repo` : Pulls cookbooks from a monolithic cookbook repository. This may be a path to the top-level of a cookbook repository or to the `/cookbooks` directory within that repository.