Skip to content

Update Documentation for Artifactory Authentication Options #4330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 9, 2025
Merged

Update Documentation for Artifactory Authentication Options #4330

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6339786
Update Documentation for Artifactory Authentication Options
Nov 11, 2024
43d0795
Edits
IanMadd Nov 18, 2024
b3305f8
Merge branch 'main' into sanjain/CHEF-16989/authenticate_by_identity_…
IanMadd Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions content/config_rb_policyfile.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading