Skip to content

Commit

Permalink
Update Documentation for Artifactory Authentication Options
Browse files Browse the repository at this point in the history 
Signed-off-by: Sachin <[email protected]>
  • Loading branch information
Sachin committed Nov 11, 2024
1 parent be13245 commit c8ea501
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions content/reusable/md/policyfile_rb_settings.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Check failure on line 30 in content/reusable/md/policyfile_rb_settings.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[write-good.ThereIs] Don't start a sentence with 'There are'.

Raw Output:
{"message": "[write-good.ThereIs] Don't start a sentence with 'There are'.", "location": {"path": "content/reusable/md/policyfile_rb_settings.md", "range": {"start": {"line": 30, "column": 3}}}, "severity": "ERROR"}
- **API Key**: Set `artifactory_api_key` in config.rb or use the environment variable `ARTIFACTORY_API_KEY`.

Check failure on line 31 in content/reusable/md/policyfile_rb_settings.md

View workflow job for this annotation

GitHub Actions / markdownlint

Lists should be surrounded by blank lines [Context: "- **API Key**: Set `artifactor..."] 

content/reusable/md/policyfile_rb_settings.md:31 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- **API Key**: Set `artifactor..."]
- **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"`.

Expand Down

0 comments on commit c8ea501

Please sign in to comment.