Create AWX docsite with RST content (#14328)
Co-authored-by: Thanhnguyet Vo <tvo@ansible.com> Co-authored-by: TVo <thavo@redhat.com>
32
docs/docsite/rst/common/add-token.rst
Normal file
@@ -0,0 +1,32 @@
|
||||
|
||||
|
||||
2. Click the **Tokens** tab from your user's profile.
|
||||
|
||||
When no tokens are present, the Tokens screen prompts you to add them:
|
||||
|
||||
.. image:: ../common/images/users-tokens-empty.png
|
||||
|
||||
3. Click the **Add** button, which opens the Create Token window.
|
||||
|
||||
4. Enter the following details in Create Token window:
|
||||
|
||||
- **Application**: enter the name of the application with which you want to associate your token. Alternatively, you can search for it by clicking the |search| button. This opens a separate window that allows you to choose from the available options. Use the Search bar to filter by name if the list is extensive. Leave this field blank if you want to create a Personal Access Token (PAT) that is not linked to any application.
|
||||
|
||||
- **Description**: optionally provide a short description for your token.
|
||||
|
||||
- **Scope** (required): specify the level of access you want this token to have.
|
||||
|
||||
.. |search| image:: ../common/images/search-button.png
|
||||
|
||||
5. When done, click **Save** or **Cancel** to abandon your changes.
|
||||
|
||||
After the token is saved, the newly created token for the user displays with the token information and when it expires.
|
||||
|
||||
.. image:: ../common/images/users-token-information-example.png
|
||||
|
||||
.. note:: This is the only time the token value and associated refresh token value will ever be shown.
|
||||
|
||||
In the user's profile, the application for which it is assigned to and its expiration displays in the token list view.
|
||||
|
||||
.. image:: ../common/images/users-token-assignment-example.png
|
||||
|
||||
36
docs/docsite/rst/common/containergroup-sa.yml
Normal file
@@ -0,0 +1,36 @@
|
||||
---
|
||||
apiVersion: v1
|
||||
kind: ServiceAccount
|
||||
metadata:
|
||||
name: containergroup-service-account
|
||||
namespace: containergroup-namespace
|
||||
---
|
||||
kind: Role
|
||||
apiVersion: rbac.authorization.k8s.io/v1
|
||||
metadata:
|
||||
name: role-containergroup-service-account
|
||||
namespace: containergroup-namespace
|
||||
rules:
|
||||
- apiGroups: [""]
|
||||
resources: ["pods"]
|
||||
verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
|
||||
- apiGroups: [""]
|
||||
resources: ["pods/log"]
|
||||
verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
|
||||
- apiGroups: [""]
|
||||
resources: ["pods/attach"]
|
||||
verbs: ["get", "list", "watch", "create", "update", "patch", "delete"]
|
||||
---
|
||||
kind: RoleBinding
|
||||
apiVersion: rbac.authorization.k8s.io/v1
|
||||
metadata:
|
||||
name: role-containergroup-service-account-binding
|
||||
namespace: containergroup-namespace
|
||||
subjects:
|
||||
- kind: ServiceAccount
|
||||
name: containergroup-service-account
|
||||
namespace: containergroup-namespace
|
||||
roleRef:
|
||||
kind: Role
|
||||
name: role-containergroup-service-account
|
||||
apiGroup: rbac.authorization.k8s.io
|
||||
28
docs/docsite/rst/common/copyright.rst
Normal file
@@ -0,0 +1,28 @@
|
||||
Copyright © Red Hat, Inc.
|
||||
===============================
|
||||
|
||||
Ansible, |aap|, Red Hat, and |rhel| are trademarks of Red Hat, Inc., registered in the United States and other countries.
|
||||
|
||||
If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original version.
|
||||
|
||||
**Third Party Rights**
|
||||
|
||||
Ubuntu and Canonical are registered trademarks of Canonical Ltd.
|
||||
|
||||
The CentOS Project is copyright protected. The CentOS Marks are trademarks of Red Hat, Inc. (“Red Hat”).
|
||||
|
||||
Microsoft, Windows, Windows Azure, and Internet Explore are trademarks of Microsoft, Inc.
|
||||
|
||||
VMware is a registered trademark or trademark of VMware, Inc.
|
||||
|
||||
Amazon Web Services", "AWS", "Amazon EC2", and "EC2”, are trademarks of Amazon Web Services, Inc. or its affiliates.
|
||||
|
||||
OpenStack™ and OpenStack logo are trademarks of OpenStack, LLC.
|
||||
|
||||
Chrome™ and Google Compute Engine™ service registered trademarks of Google Inc.
|
||||
|
||||
Safari® is a registered trademark of Apple, Inc.
|
||||
|
||||
Firefox® is a registered trademark of the Mozilla Foundation.
|
||||
|
||||
All other trademarks are the property of their respective owners.
|
||||
2
docs/docsite/rst/common/execution_environs.rst
Normal file
@@ -0,0 +1,2 @@
|
||||
|
||||
The ability to build and deploy Python virtual environments for automation has been replaced by Ansible execution environments. Unlike legacy virtual environments, execution environments are container images that make it possible to incorporate system-level dependencies and collection-based content. Each execution environment allows you to have a customized image to run jobs, and each of them contain only what you need when running the job, nothing more.
|
||||
33
docs/docsite/rst/common/get-creds-from-service-account.rst
Normal file
@@ -0,0 +1,33 @@
|
||||
|
||||
A ``ContainerGroup`` is a type of ``InstanceGroup`` that has an associated Credential that allows for connecting to an OpenShift cluster. To set up a container group, you must first have the following:
|
||||
|
||||
- A namespace you can launch into (every cluster has a “default” namespace, but you may want to use a specific namespace)
|
||||
- A service account that has the roles that allow it to launch and manage Pods in this namespace
|
||||
- If you will be using |ees| in a private registry, and have a Container Registry credential associated to them in AWX, the service account also needs the roles to get, create, and delete secrets in the namespace. If you do not want to give these roles to the service account, you can pre-create the ``ImagePullSecrets`` and specify them on the pod spec for the ContainerGroup. In this case, the |ee| should NOT have a Container Registry credential associated, or AWX will attempt to create the secret for you in the namespace.
|
||||
- A token associated with that service account (OpenShift or Kubernetes Bearer Token)
|
||||
- A CA certificate associated with the cluster
|
||||
|
||||
This section describes creating a Service Account in an Openshift cluster (or K8s) in order to be used to run jobs in a container group via AWX. After the Service Account is created, its credentials are provided to AWX in the form of an Openshift or Kubernetes API bearer token credential. Below describes how to create a service account and collect the needed information for configuring AWX.
|
||||
|
||||
To configure AWX:
|
||||
|
||||
1. To create a service account, you may download and use this sample service account, :download:`containergroup sa <../common/containergroup-sa.yml>` and modify it as needed to obtain the above credentials.
|
||||
|
||||
2. Apply the configuration from ``containergroup-sa.yml``::
|
||||
|
||||
oc apply -f containergroup-sa.yml
|
||||
|
||||
|
||||
3. Get the secret name associated with the service account::
|
||||
|
||||
export SA_SECRET=$(oc get sa containergroup-service-account -o json | jq '.secrets[0].name' | tr -d '"')
|
||||
|
||||
4. Get the token from the secret::
|
||||
|
||||
oc get secret $(echo ${SA_SECRET}) -o json | jq '.data.token' | xargs | base64 --decode > containergroup-sa.token
|
||||
|
||||
5. Get the CA cert::
|
||||
|
||||
oc get secret $SA_SECRET -o json | jq '.data["ca.crt"]' | xargs | base64 --decode > containergroup-ca.crt
|
||||
|
||||
6. Use the contents of ``containergroup-sa.token`` and ``containergroup-ca.crt`` to provide the information for the :ref:`ug_credentials_ocp_k8s` required for the container group.
|
||||
BIN
docs/docsite/rst/common/images/AWXHierarchy.png
Normal file
|
After Width: | Height: | Size: 39 KiB |
|
After Width: | Height: | Size: 102 KiB |
|
After Width: | Height: | Size: 85 KiB |
BIN
docs/docsite/rst/common/images/Fact-Scan-Retention-Timeline.png
Normal file
|
After Width: | Height: | Size: 35 KiB |
BIN
docs/docsite/rst/common/images/activity-stream-button.png
Normal file
|
After Width: | Height: | Size: 851 B |
BIN
docs/docsite/rst/common/images/activity-stream-event-log.png
Normal file
|
After Width: | Height: | Size: 80 KiB |
BIN
docs/docsite/rst/common/images/activitystream.png
Normal file
|
After Width: | Height: | Size: 1.3 KiB |
BIN
docs/docsite/rst/common/images/ad-hoc-button.png
Normal file
|
After Width: | Height: | Size: 7.1 KiB |
|
After Width: | Height: | Size: 77 KiB |
|
After Width: | Height: | Size: 43 KiB |
|
After Width: | Height: | Size: 66 KiB |
BIN
docs/docsite/rst/common/images/ad-hoc-run-execute-command.png
Normal file
|
After Width: | Height: | Size: 58 KiB |
BIN
docs/docsite/rst/common/images/add-admin-button.png
Normal file
|
After Width: | Height: | Size: 4.5 KiB |
BIN
docs/docsite/rst/common/images/add-options-groups.png
Normal file
|
After Width: | Height: | Size: 5.6 KiB |
BIN
docs/docsite/rst/common/images/add-options-hosts.png
Normal file
|
After Width: | Height: | Size: 4.8 KiB |
BIN
docs/docsite/rst/common/images/add-options-inventories.png
Normal file
|
After Width: | Height: | Size: 5.0 KiB |
BIN
docs/docsite/rst/common/images/add-options-template.png
Normal file
|
After Width: | Height: | Size: 8.3 KiB |
BIN
docs/docsite/rst/common/images/add-survey-button.png
Normal file
|
After Width: | Height: | Size: 4.3 KiB |
BIN
docs/docsite/rst/common/images/add-user-button.png
Normal file
|
After Width: | Height: | Size: 2.9 KiB |
BIN
docs/docsite/rst/common/images/admin.png
Normal file
|
After Width: | Height: | Size: 2.9 KiB |
BIN
docs/docsite/rst/common/images/ansible-signing-verify-arch.key
Normal file
BIN
docs/docsite/rst/common/images/api-questionmark.png
Normal file
|
After Width: | Height: | Size: 613 B |
|
After Width: | Height: | Size: 65 KiB |
|
After Width: | Height: | Size: 94 KiB |
BIN
docs/docsite/rst/common/images/apps-client-id-popup.png
Normal file
|
After Width: | Height: | Size: 171 KiB |
BIN
docs/docsite/rst/common/images/apps-create-new.png
Normal file
|
After Width: | Height: | Size: 97 KiB |
BIN
docs/docsite/rst/common/images/apps-list-view-empty.png
Normal file
|
After Width: | Height: | Size: 81 KiB |
BIN
docs/docsite/rst/common/images/apps-list-view-examples.png
Normal file
|
After Width: | Height: | Size: 134 KiB |
|
After Width: | Height: | Size: 124 KiB |
|
After Width: | Height: | Size: 112 KiB |
BIN
docs/docsite/rst/common/images/back.png
Normal file
|
After Width: | Height: | Size: 1.0 KiB |
BIN
docs/docsite/rst/common/images/close-button.png
Normal file
|
After Width: | Height: | Size: 1.4 KiB |
BIN
docs/docsite/rst/common/images/clustering-visual.png
Normal file
|
After Width: | Height: | Size: 86 KiB |
|
After Width: | Height: | Size: 207 KiB |
BIN
docs/docsite/rst/common/images/compare-hosts-button.png
Normal file
|
After Width: | Height: | Size: 1.7 KiB |
BIN
docs/docsite/rst/common/images/configure-awx-auth-azure-logo.png
Normal file
|
After Width: | Height: | Size: 192 KiB |
BIN
docs/docsite/rst/common/images/configure-awx-auth-basic-off.png
Normal file
|
After Width: | Height: | Size: 62 KiB |
|
After Width: | Height: | Size: 193 KiB |
|
After Width: | Height: | Size: 194 KiB |
|
After Width: | Height: | Size: 193 KiB |
|
After Width: | Height: | Size: 192 KiB |
|
After Width: | Height: | Size: 193 KiB |
|
After Width: | Height: | Size: 192 KiB |
|
After Width: | Height: | Size: 192 KiB |
BIN
docs/docsite/rst/common/images/configure-awx-auth-google.png
Normal file
|
After Width: | Height: | Size: 53 KiB |
|
After Width: | Height: | Size: 11 KiB |
|
After Width: | Height: | Size: 9.0 KiB |
|
After Width: | Height: | Size: 13 KiB |
|
After Width: | Height: | Size: 12 KiB |
|
After Width: | Height: | Size: 81 KiB |
|
After Width: | Height: | Size: 7.8 KiB |
|
After Width: | Height: | Size: 16 KiB |
|
After Width: | Height: | Size: 26 KiB |
BIN
docs/docsite/rst/common/images/configure-awx-auth-oidc-logo.png
Normal file
|
After Width: | Height: | Size: 196 KiB |
BIN
docs/docsite/rst/common/images/configure-awx-auth-oidc.png
Normal file
|
After Width: | Height: | Size: 131 KiB |
BIN
docs/docsite/rst/common/images/configure-awx-auth-saml-cert.png
Normal file
|
After Width: | Height: | Size: 44 KiB |
|
After Width: | Height: | Size: 129 KiB |
BIN
docs/docsite/rst/common/images/configure-awx-auth-saml-idps.png
Normal file
|
After Width: | Height: | Size: 118 KiB |
BIN
docs/docsite/rst/common/images/configure-awx-auth-saml-logo.png
Normal file
|
After Width: | Height: | Size: 192 KiB |
|
After Width: | Height: | Size: 28 KiB |
|
After Width: | Height: | Size: 11 KiB |
|
After Width: | Height: | Size: 18 KiB |
|
After Width: | Height: | Size: 18 KiB |
|
After Width: | Height: | Size: 83 KiB |
BIN
docs/docsite/rst/common/images/configure-awx-auth-tacacs.png
Normal file
|
After Width: | Height: | Size: 44 KiB |
|
After Width: | Height: | Size: 17 KiB |
|
After Width: | Height: | Size: 17 KiB |
|
After Width: | Height: | Size: 62 KiB |
BIN
docs/docsite/rst/common/images/configure-awx-jobs-callback.png
Normal file
|
After Width: | Height: | Size: 42 KiB |
|
After Width: | Height: | Size: 86 KiB |
|
After Width: | Height: | Size: 86 KiB |
|
After Width: | Height: | Size: 87 KiB |
|
After Width: | Height: | Size: 115 KiB |
|
After Width: | Height: | Size: 207 KiB |
|
After Width: | Height: | Size: 22 KiB |
BIN
docs/docsite/rst/common/images/configure-awx-jobs.png
Normal file
|
After Width: | Height: | Size: 235 KiB |
BIN
docs/docsite/rst/common/images/configure-awx-session-limits.png
Normal file
|
After Width: | Height: | Size: 84 KiB |
|
After Width: | Height: | Size: 128 KiB |
|
After Width: | Height: | Size: 93 KiB |
|
After Width: | Height: | Size: 72 KiB |
|
After Width: | Height: | Size: 96 KiB |
|
After Width: | Height: | Size: 10 KiB |
|
After Width: | Height: | Size: 83 KiB |
|
After Width: | Height: | Size: 83 KiB |
|
After Width: | Height: | Size: 82 KiB |
BIN
docs/docsite/rst/common/images/configure-awx-system-timeout.png
Normal file
|
After Width: | Height: | Size: 89 KiB |
BIN
docs/docsite/rst/common/images/configure-awx-system.png
Normal file
|
After Width: | Height: | Size: 139 KiB |
|
After Width: | Height: | Size: 192 KiB |
BIN
docs/docsite/rst/common/images/configure-awx-ui-logo-filled.png
Normal file
|
After Width: | Height: | Size: 80 KiB |
BIN
docs/docsite/rst/common/images/configure-awx-ui.png
Normal file
|
After Width: | Height: | Size: 41 KiB |
|
After Width: | Height: | Size: 13 KiB |
BIN
docs/docsite/rst/common/images/content-sign-diagram.png
Normal file
|
After Width: | Height: | Size: 168 KiB |
BIN
docs/docsite/rst/common/images/copy-button.png
Normal file
|
After Width: | Height: | Size: 1003 B |
BIN
docs/docsite/rst/common/images/create-button.png
Normal file
|
After Width: | Height: | Size: 1.3 KiB |
BIN
docs/docsite/rst/common/images/credential-types-create-new.png
Normal file
|
After Width: | Height: | Size: 146 KiB |