Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ This is a command line interface for Pulp 3.

This software is in beta and future releases may include backwards incompatible changes.

Check out our [docs](https://docs.pulpproject.org/pulp_cli/) and the [quickstart guide](https://docs.pulpproject.org/pulp_cli/installation/#tldr-get-started-real-fast) to get started.
Check out our [docs](https://docs.pulpproject.org/pulp_cli/) and the
[quickstart guide](https://pulpproject.org/pulp-cli/docs/user/guides/installation/#tldr-get-started-real-fast) to get started.
2 changes: 1 addition & 1 deletion docs/dev/guides/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ And finally, for each new feature, we require corresponding tests.
## Testing

Tests are shell scripts in `tests/scripts` with names like `test_*.sh`.
They should should focus on the cli operation and are not a replacement for pulp integration tests;
They should focus on the cli operation and are not a replacement for pulp integration tests;
i.e. make sure the cli translates to the right api calls, but do not care about pulp internals.

## Running Tests
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Currently `pulp-cli` supports pulpcore and 6 of Pulp's plugins: `pulp_ansible`,
See section below for information on how to extend the CLI to support other Pulp plugins.

You can find workflow examples for the Pulp 3 CLI throughout the [plugin documentation](site:help/).
For example, [synchronizing a File repository](site:/pulp_file/docs/user/guides/01-sync/).
For example, [synchronizing a File repository](site:/pulp_file/docs/user/guides/sync/).

Use the links on the left to navigate.

Expand Down
2 changes: 1 addition & 1 deletion docs/user/guides/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,5 +77,5 @@ therefore you should install pulp-cli only on the primary server, and override t
It can be helpful to use the `--profile` option here.

As Katello uses Pulp as a backend, all modifying actions in Pulp should be performed via Katello.
Therefore you are also strongly encourged to set `dry_run = true`, to prevent accidentally calling into dangerous commands.
Therefore you are also strongly encouraged to set `dry_run = true`, to prevent accidentally calling into dangerous commands.
This setting can in turn be overwritten on the command-line with the `--force` flag.
9 changes: 6 additions & 3 deletions docs/user/reference/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,13 @@ Some very simple and common, like HTTP Basic Auth, and some more complex like OA
## OAuth2 ClientCredentials grant

!!! warning
This is an experimental feature. The support of it could change without any major warning.

More on https://datatracker.ietf.org/doc/html/rfc6749#section-4.4
This is an experimental feature. The support of it could change without any major warning.

For more information, see [RFC6749 section 4.4].

Using this method the pulp-cli can request a token from an Identity Provider using a pair of
credentials (client_id/client_secret). The token is ten sent through using the `Authorization` header.
credentials (client_id/client_secret). The token is then sent through using the `Authorization` header.
The issuer URL and the scope of token must be specified by the Pulp server through the OpenAPI scheme definition.

[RFC6749 section 4.4]: https://datatracker.ietf.org/doc/html/rfc6749#section-4.4
Loading