Added create credentials/inventories, github app token #92
Conversation
for more information, see https://pre-commit.ci
…tvo318/awx-plugins into creds-inventory-github-app-docs
There was a problem hiding this comment.
This doesn't look like an image to me...
There was a problem hiding this comment.
It's not, where should I put it?
There was a problem hiding this comment.
Dunno, depending on how it's used.
|
That's a huge chunk of changes. Perhaps, split this into smaller PRs doing one thing at a time? |
|
@webknjaz I agree it is big, but it was existing content that had been reviewed and approved before. And much of it is removing content. Maybe we can just focus on the new credential plugin (GitHub app) and get this PR merged and if we need to make additional changes, we can open follow-on PRs? |
|
@tvo318 we can't merge this because it breaks the CI and mustn't introduce linting violations. It'd be easier to review parts of it like removal. Otherwise, don't expect a quick review timeline, since this now requires substantial time investment to review. |
| .. _ug_inventories_add_host: | ||
|
|
||
| Add hosts | ||
| ------------ |
There was a problem hiding this comment.
the underline must match the text of the title
| Inventory Sources | ||
| ^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| To configure inventory sources, refer to `ug_inventories_plugins`. |
There was a problem hiding this comment.
Looks like there's a lot of title mismatches, which is something you have to fix for RST to be happy. I've also seen a number of places with unspecified highlighting. Some would benefit from yaml+jinja. Others need console (for shell session snippets).
There's one place with single backticks that the linters caught, a yamllint issue (the file must be edited to match the linter config). Also, a misplaced YAML file in the directory layout — it shouldn't be in the images directory because it's a text file and not an image. Where is it even used?
This is just off the top of my head. There's probably some other blockers.
| .. _ug_inventory_sources: | ||
|
|
||
| Inventory Sources | ||
| ^^^^^^^^^^^^^^^^^^^^^^ |
| .. _ug_customscripts: | ||
|
|
||
| Export old inventory scripts | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
|
@tvo318 could you fix the PR title to be in imperative mood and reference to one single topic per typical Git commit best practices? |
|
It should probably clarify that you're adding the docs and aren't deleting actual code… |
| .. index:: | ||
| single: credentials | ||
| pair: credentials; multi | ||
| pair: credentials; assignment |
There was a problem hiding this comment.
https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#index-generating-markup implies this is for some references but I don't see where it's used...
|
|
||
| You can verify functionality with ``ansible-inventory``. This should give the same data, but reformatted. | ||
|
|
||
| .. code-block:: bash |
There was a problem hiding this comment.
This isn't bash. It's actually console.
|
|
||
| Each file contains a script. Scripts can be ``bash/python/ruby/more``, so the extension is not included. They are all directly executable (assuming the scripts worked). If you execute the script, it dumps the inventory data. | ||
|
|
||
| .. code-block:: bash |
There was a problem hiding this comment.
The console lexer is supposed to be used for terminal sessions with prompts and outputs.
| Despite the removal of the custom inventory scripts API, the scripts are still saved in the database. The commands described in this section allows you to recover the scripts in a format that is suitable for you to subsequently check into source control. Usage looks like this: | ||
|
|
||
|
|
||
| :: |
|
|
||
| To configure AWX: | ||
|
|
||
| 1. To create a service account, you may download and use this sample service account, :download:`containergroup sa <_static/images/containergroup-sa.yml>` and modify it as needed to obtain the above credentials. |
There was a problem hiding this comment.
Oh, is this where it's used? Create some other folder in the static dir, then. Maybe name it “samples” or something.
|
|
||
| 1. To create a service account, you may download and use this sample service account, :download:`containergroup sa <_static/images/containergroup-sa.yml>` and modify it as needed to obtain the above credentials. | ||
|
|
||
| 2. Apply the configuration from ``containergroup-sa.yml``:: |
There was a problem hiding this comment.
Use the :file: role for things that look like file/dir paths.
|
|
||
| 5. Get the CA cert:: | ||
|
|
||
| oc get secret $SA_SECRET -o json | jq '.data["ca.crt"]' | xargs | base64 --decode > containergroup-ca.crt |
There was a problem hiding this comment.
This could probably be highlighted as bash. Or console if you add a $-prompt prefix.
This PR achieves the following:
See rendered (staged) content here: https://awx-plugins-core--92.org.readthedocs.build/en/92/