Skip to content

DITA migration changes: CUG Ch 23 #3854

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+35 −33
Open

DITA migration changes: CUG Ch 23 #3854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 7 additions & 3 deletions downstream/assemblies/platform/assembly-controller-custom-credentials.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,17 @@ Vault credentials and machine credentials are separate entities.
====
* When creating a new credential type, you must avoid collisions in the `extra_vars`, `env`, and file namespaces.
* Environment variable or extra variable names must not start with `ANSIBLE_` because they are reserved.
* You must have System administrator (superuser) permissions to be able to create and edit a credential type (`CredentialType`) and to be
able to view the `CredentialType.injection` field.
* You must have System administrator (superuser) permissions to be able to create and edit a credential type (`CredentialType`) and be able to view the `CredentialType.injection` field.
====

include::platform/ref-controller-content-sourcing.adoc[leveloffset=+1]

include::platform/ref-controller-api-considerations.adoc[leveloffset=+1]
include::platform/ref-get-started-credential-types.adoc[leveloffset=+1]

include::platform/con-controller-content-verification.adoc[leveloffset=+2]

include::platform/proc-get-started-credential-types.adoc[leveloffset=+1]

include::platform/proc-controller-create-credential-type.adoc[leveloffset=+1]


Expand Down
Binary file added downstream/images/credential-types-listed-verify.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified downstream/images/credential-types-new-listed-verify.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified downstream/images/organizations-galaxy-credentials.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 8 additions & 0 deletions downstream/modules/platform/con-controller-content-verification.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[id="con-controller-content-verification"]

= Content verification

{ControllerNameStart} uses GNU Privacy Guard (GPG) to verify content.

For more information, see
link:https://www.gnupg.org/gph/en/manual/c14.html#:~:text=GnuPG%20uses%20public%2Dkey%20cryptography,the%20user%20wants%20to%20communicate[The GNU Privacy Handbook].
4 changes: 2 additions & 2 deletions downstream/modules/platform/proc-controller-create-credential-type.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,8 +208,8 @@ If the *Delete* option is disabled, this means that the credential type is being

* Verify that the newly created credential type can be selected from the *Credential Type* selection window when creating a new credential:

image:credential-types-new-listed-verify.png[Verify new credential type]
image:credential-types-listed-verify.png[Verify new credential type]

.Additional resources

For information about how to create a new credential, see xref:controller-create-credential[Creating a credential].
For information about how to create a new credential, see link:{URLControllerUserGuide}/controller-credentials#controller-create-credential[Creating a credential].
14 changes: 8 additions & 6 deletions ...orm/ref-get-started-credential-types.adoc → ...rm/proc-get-started-credential-types.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
:_mod-docs-content-type: REFERENCE
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update REFERENCE to PROCEDURE


[id="ref-get-started-credential-types"]
[id="proc-get-started-credential-types"]

= Getting started with credential types
//[ddacosta] Consider rewriting this as a procedure.

.Procedure
. From the navigation panel, select {MenuAECredentials}.
+
If no custom credential types have been created, the *Credential Types* page prompts you to add one.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This might flag in VALE as it's not a step. "Content other than a single list cannot be mapped to DITA tasks."

Not 100% sure because you're using "+", you might get away with it

+
//image:credential-types-home-empty.png[Credential Types - empty]
+
If credential types have been created, this page displays a list of existing and available Credential Types.
+
//+
//image:credential-types-home-with-example-types.png[Credential Types - example credential types]

. Select the name of a credential or the Edit image:leftpencil.png[Edit, 15,15] icon to view more information about a credential type, .
. Select the name of a credential or the Edit image:leftpencil.png[Edit, 15,15] icon to view more information about a credential type.

. On the *Details* tab, each credential type displays its own unique configurations in the *Input Configuration* field and the *Injector Configuration* field, if applicable.
. On the *Details* tab, each credential type displays its own unique configurations
//Can't see these fields
// in the *Input Configuration* field and the *Injector Configuration* field, if applicable
.
Both YAML and JSON formats are supported in the configuration fields.

//NOTE The Back to Credential Types Tab throws an error.
14 changes: 2 additions & 12 deletions downstream/modules/platform/ref-controller-api-considerations.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,7 @@ support).

You can filter credentials the v2 API:

[literal, options="nowrap" subs="+attributes"]
----
curl "https://controller.example.org/api/v2/credentials/?credential_type__namespace=aws"
----
`curl "https://controller.example.org/api/v2/credentials/?credential_type__namespace=aws"`

In the V2 Credential Type model, the relationships are defined as follows:

Expand All @@ -27,11 +24,4 @@ In the V2 Credential Type model, the relationships are defined as follows:
| Insights |Insights
| Galaxy | galaxy.ansible.com, console.redhat.com
| Galaxy | on-premise {HubName}
|===

= Content verification

{ControllerNameStart} uses GNU Privacy Guard (GPG) to verify content.

For more information, see
link:https://www.gnupg.org/gph/en/manual/c14.html#:~:text=GnuPG%20uses%20public%2Dkey%20cryptography,the%20user%20wants%20to%20communicate[The GNU Privacy Handbook].
|===
18 changes: 8 additions & 10 deletions downstream/modules/platform/ref-controller-content-sourcing.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,24 @@

= Content sourcing from collections

A "managed" credential type of `kind=galaxy` represents a content source for fetching collections defined in `requirements.yml` when project
updates are run.
A "managed" credential type of `kind=galaxy` represents a content source for fetching collections defined in `requirements.yml` when project updates are run.
Examples of content sources are galaxy.ansible.com, {Console}, or on-premise {HubName}.

This new credential type represents a URL and (optional) authentication details necessary to construct the environment variables when a project update runs `ansible-galaxy collection install` as described in the Ansible documentation, link:https://docs.ansible.com/ansible/latest/collections_guide/collections_installing.html#configuring-the-ansible-galaxy-client[Configuring the ansible-galaxy client].
It has fields that map directly to the configuration options exposed to the {Galaxy} CLI, for example, per-server.

An endpoint in the API reflects an ordered list of these credentials at the Organization level:
+
`/api/v2/organizations/N/galaxy_credentials/`

[literal, options="nowrap" subs="+attributes"]
----
/api/v2/organizations/N/galaxy_credentials/
----

When installations of {ControllerName} migrate existing Galaxy-oriented setting values, post-upgrade proper credentials are created and
attached to every Organization.
When installations of {ControllerName} migrate existing Galaxy-oriented setting values, post-upgrade proper credentials are created and attached to every Organization.
//Check the following for 2.6
After upgrading to the latest version, every organization that existed before upgrade now has a list of one or more "Galaxy" credentials associated with it.

Additionally, post-upgrade, these settings are not visible (or editable) from the `/api/v2/settings/jobs/` endpoint.

{ControllerNameStart} continues to fetch roles directly from public Galaxy even if `galaxy.ansible.com` is not the first credential in the list for the organization. The global Galaxy settings are no longer configured at the jobs level, but at the organization level in the user interface.
{ControllerNameStart} continues to fetch roles directly from public Galaxy even if `galaxy.ansible.com` is not the first credential in the list for the organization.
The global Galaxy settings are no longer configured at the jobs level, but at the organization level in the user interface.

The organization's *Create organization* and *Edit organization* windows have an optional *Galaxy credentials* lookup field for credentials of `kind=galaxy`.

Expand Down