Document GitHub App Access Token lookup credential plugin #95
+76
−10
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
arrestle
approved these changes
Mar 3, 2025
PabloHiro
reviewed
Mar 4, 2025
docs/_static/images/credentials-create-github-app-lookup-credential.png
Outdated
Show resolved
Hide resolved
| 4. Create a target credential that looks up the lookup credential. To use your lookup in a private repo, use **Source Control** as your Credential type. Provide the following attributes to properly configure your target credential: | ||
|
|
||
| - **Username**: provide the username of ``x-access-token`` | ||
| - **Password** (required): click the |key| button of the input field. You are prompted to set the input source to use to retrieve your secret information - this is the credential that you created in the previous step. |
There was a problem hiding this comment.
I would appreciate a screenshot of this step. It would tie with the first part of the documentation and someone familiar with AAP can complete this by following the images with only having to read the text diagonally.
There was a problem hiding this comment.
I do have a screen shot for this. Do you see it in the rendered version, @PabloHiro?
There was a problem hiding this comment.
Yeah, that one is rendered correctly. I was referring to what happens when you click the "key" button, that is a different view right?
There was a problem hiding this comment.
Yes, we can add it if it helps.
webknjaz
approved these changes
Mar 4, 2025
|
|
||
| 3. Click **Create Credential** to confirm and save the credential. | ||
|
|
||
| 4. Create a target credential that looks up the lookup credential. To use your lookup in a private repo, use **Source Control** as your Credential type. Provide the following attributes to properly configure your target credential: |
There was a problem hiding this comment.
looks up the lookup
Any way to rephrase this?
| GitHub App Token Lookup | ||
| ~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| This plugin allows a GitHub app token to be used as a credential input source to pull secrets from GitHub App. AWX uses existing GitHub auth from organizations' GitHub repos. Refer to `Generating an installation access token for a GitHub App <https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/generating-an-installation-access-token-for-a-github-app>`_ for more detail. |
There was a problem hiding this comment.
Here and in other places, use full words instead of slang. This will make the linter pass: https://github.com/ansible/awx-plugins/actions/runs/13636241048/job/38116085927?pr=95#step:15:96.
| 1. Create a lookup credential that stores your secrets. See TBD for detail. | ||
| ..(link available in separate PR that has this information). | ||
|
|
||
| 2. When **GitHub App Installation Access Token lookup** is selected for **Credential Type**, provide the following attributes to properly configure your lookup: |
There was a problem hiding this comment.
Suggested change
| 2. When **GitHub App Installation Access Token lookup** is selected for **Credential Type**, provide the following attributes to properly configure your lookup: | |
| 2. When :guilabel:`GitHub App Installation Access Token lookup` is selected for :guilabel:`Credential Type`, provide the following attributes to properly configure your lookup: |
| .. image:: _static/images/credentials-create-target-github-app-credential.png | ||
| :alt: Example of creating a target credential that uses source control | ||
|
|
||
| 6. Click **Create Credential** to confirm and save the credential. |
There was a problem hiding this comment.
Suggested change
| 6. Click **Create Credential** to confirm and save the credential. | |
| 6. Click :guilabel:`Create Credential` to confirm and save the credential. |
| - **Username**: provide the username of ``x-access-token`` | ||
| - **Password** (required): click the |key| button of the input field. You are prompted to set the input source to use to retrieve your secret information - this is the credential that you created in the previous step. | ||
|
|
||
| 5. Enter an optional description for the metadata requested and click **Finish**. |
There was a problem hiding this comment.
Suggested change
| 5. Enter an optional description for the metadata requested and click **Finish**. | |
| 5. Enter an optional description for the metadata requested and click :guilabel:`Finish`. |
| .. image:: _static/images/project-create-git-github-app.png | ||
| :alt: Example of a project pointing to a private git repo | ||
|
|
||
| 9. Click **Save** and the project sync automatically starts and the project Details displays the progress of the job. |
There was a problem hiding this comment.
Suggested change
| 9. Click **Save** and the project sync automatically starts and the project Details displays the progress of the job. | |
| 9. Click :guilabel:`Save` and the project sync automatically starts and the project Details displays the progress of the job. |
| - **Name** (required): provide the name for your project | ||
| - **Organization** (required): select the name of the organization from the drop-down menu | ||
| - **Execution environment**: optionally select an execution environment, if applicable | ||
| - **Source control type** (required): If you are syncing with a private repo, select **Git** for your source control. |
There was a problem hiding this comment.
Suggested change
| - **Source control type** (required): If you are syncing with a private repo, select **Git** for your source control. | |
| - **Source control type** (required): If you are syncing with a private repo, select :guilabel:`Git` for your source control. |
webknjaz
requested changes
Mar 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added the GitHub App Install token procedure (AAP-39191) to the credential plugins section of the documentation.
See rendered version here: https://awx-plugins-core--95.org.readthedocs.build/en/95/credential-plugins/#ug-credentials-github-app-lookup