Skip to content

Commit

Permalink
Update Documentation for Artifactory Authentication Options (#4330)
Browse files Browse the repository at this point in the history
* Update Documentation for Artifactory Authentication Options

Signed-off-by: Sachin <[email protected]>

* Edits

Signed-off-by: Ian Maddaus <[email protected]>

---------

Signed-off-by: Sachin <[email protected]>
Signed-off-by: Ian Maddaus <[email protected]>
Co-authored-by: Sachin <[email protected]>
Co-authored-by: Ian Maddaus <[email protected]>
Co-authored-by: Ian Maddaus <[email protected]>
  • Loading branch information
4 people authored Jan 9, 2025
1 parent c94de2d commit ab3ef77
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
3 changes: 1 addition & 2 deletions content/config_rb_policyfile.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 >}}

Expand Down
12 changes: 10 additions & 2 deletions content/reusable/md/policyfile_rb_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,19 @@ 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.

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.
Expand Down

0 comments on commit ab3ef77

Please sign in to comment.