diff --git a/downstream/assemblies/platform/assembly-controller-organizations.adoc b/downstream/assemblies/platform/assembly-controller-organizations.adoc index 00d379e96..bf3551478 100644 --- a/downstream/assemblies/platform/assembly-controller-organizations.adoc +++ b/downstream/assemblies/platform/assembly-controller-organizations.adoc @@ -1,5 +1,6 @@ [id="controller-organizations"] +ifdef::controller-GS[] = Managing organizations in {ControllerName} An organization is a logical collection of users, teams, projects, and inventories. @@ -10,4 +11,27 @@ You can then manage access and execution environments for the organization. image::controller-tower-hierarchy.png[Hierarchy] include::platform/proc-controller-review-organizations.adoc[leveloffset=+1] -include::platform/proc-controller-edit-an-organization.adoc[leveloffset=+1] \ No newline at end of file +include::platform/proc-controller-edit-an-organization.adoc[leveloffset=+1] +endif::controller-GS[] +ifdef::controller-UG[] += Organizations + +An organization is a logical collection of users, teams, projects, and inventories. +It is the highest level object in the controller object hierarchy. + +image::controller-tower-hierarchy.png[Hierarchy] + +From the navigation menu, select btn:[Organizations] to display the existing organizations for your installation. + +image:organizations-home-showing-example-organization.png[Organizations] + +Organizations can be searched by *Name* or *Description*. + +Modify organizations using the image:leftpencil.png[Edit,15,15] icon. +Click btn:[Delete] to remove a selected organization. + +include::platform/proc-controller-create-organization.adoc[leveloffset=+1] +include::platform/con-controller-access-organizations.adoc[leveloffset=+1] + +endif::controller-UG[] + diff --git a/downstream/images/disassociate.png b/downstream/images/disassociate.png new file mode 100644 index 000000000..2b2b12047 Binary files /dev/null and b/downstream/images/disassociate.png differ diff --git a/downstream/images/organizations-add-users-for-example-organization.png b/downstream/images/organizations-add-users-for-example-organization.png new file mode 100644 index 000000000..9828d5fb5 Binary files /dev/null and b/downstream/images/organizations-add-users-for-example-organization.png differ diff --git a/downstream/images/organizations-add-users-roles.png b/downstream/images/organizations-add-users-roles.png new file mode 100644 index 000000000..5798f9e3a Binary files /dev/null and b/downstream/images/organizations-add-users-roles.png differ diff --git a/downstream/images/organizations-home-showing-example-organization.png b/downstream/images/organizations-home-showing-example-organization.png new file mode 100644 index 000000000..a401655ef Binary files /dev/null and b/downstream/images/organizations-home-showing-example-organization.png differ diff --git a/downstream/images/organizations-max-hosts-error-output-view.png b/downstream/images/organizations-max-hosts-error-output-view.png new file mode 100644 index 000000000..d25731529 Binary files /dev/null and b/downstream/images/organizations-max-hosts-error-output-view.png differ diff --git a/downstream/images/organizations-new-organization-form.png b/downstream/images/organizations-new-organization-form.png new file mode 100644 index 000000000..783a01cdf Binary files /dev/null and b/downstream/images/organizations-new-organization-form.png differ diff --git a/downstream/images/organizations-notifications-samples-list.png b/downstream/images/organizations-notifications-samples-list.png new file mode 100644 index 000000000..0685d2297 Binary files /dev/null and b/downstream/images/organizations-notifications-samples-list.png differ diff --git a/downstream/images/organizations-show-record-for-example-organization.png b/downstream/images/organizations-show-record-for-example-organization.png new file mode 100644 index 000000000..7220837a1 Binary files /dev/null and b/downstream/images/organizations-show-record-for-example-organization.png differ diff --git a/downstream/images/organizations-show-users-permissions-organization.png b/downstream/images/organizations-show-users-permissions-organization.png new file mode 100644 index 000000000..f261b103b Binary files /dev/null and b/downstream/images/organizations-show-users-permissions-organization.png differ diff --git a/downstream/images/warning-deletion-dependencies.png b/downstream/images/warning-deletion-dependencies.png new file mode 100644 index 000000000..b0f44f3fa Binary files /dev/null and b/downstream/images/warning-deletion-dependencies.png differ diff --git a/downstream/modules/platform/con-controller-access-organizations.adoc b/downstream/modules/platform/con-controller-access-organizations.adoc new file mode 100644 index 000000000..ce0c83c7f --- /dev/null +++ b/downstream/modules/platform/con-controller-access-organizations.adoc @@ -0,0 +1,25 @@ +[id="con-controller-access-organizations"] + += Access to organizations + +* Select btn:[Access] when viewing your organization to display the users associated with this organization, and their +roles. + +image:organizations-show-users-permissions-organization.png[Organization access] + +Use this page to complete the following tasks: + +* manage the user membership for this organization. +Click btn:[Users] on the navigation panel to manage user membership on a per-user basis from the *Users* page. +* assign specific users certain levels of permissions within your organization. +* enable them to act as an administrators for a particular resource. +For more information, see link:https://docs.ansible.com/automation-controller/latest/html/userguide/security.html#rbac-ug[Role-Based Access Controls]. + +Click a user to brings up that user's details. +You can review, grant, edit, and remove associated permissions for that user. +For more information, see Users +//xref to come. + +include::proc-controller-add-organization-user.adoc[leveloffset=+1] +include::ref-controller-organization-notifications.adoc[leveloffset=+1] + diff --git a/downstream/modules/platform/proc-controller-add-organization-user.adoc b/downstream/modules/platform/proc-controller-add-organization-user.adoc new file mode 100644 index 000000000..2f2df963b --- /dev/null +++ b/downstream/modules/platform/proc-controller-add-organization-user.adoc @@ -0,0 +1,36 @@ +[id="proc-controller-add-organization-user"] + += Add a User or Team + +To add a user or team to an organization, the user or team must already exist. +//For more information, see [Creating a User] and [Creating a Team]. +To add existing users or team to the Organization: + +.Procedure +. In the *Access tab*, click btn:[Add]. +. Select a user or team to add. +. Click btn:[Next] +. Select one or more users or teams from the list by clicking the check box next to the name to add them as members. +. Click btn:[Next]. ++ +image:organizations-add-users-for-example-organization.png[Add roles] ++ +In this example, two users have been selected to be added. +. Select the role you want the selected user or team to have. +Scroll down for a complete list of roles. +Different resources have different options available. ++ +image:organizations-add-users-roles.png[Add user roles] +. Click btn:[Save] to apply the roles to the selected user or team, and to add them as members. +The *Add Users* or *Add Teams* window displays the updated roles assigned for each user and team. ++ +[NOTE] +==== +A user or team with associated roles retains them if they are reassigned to another organization. +==== +. To remove roles for a particular user, click the disassociate image:disassociate.png[Disassociate,10,10] icon next to its resource. +This launches a confirmation dialog, asking you to confirm the disassociation. + + + + diff --git a/downstream/modules/platform/proc-controller-create-organization.adoc b/downstream/modules/platform/proc-controller-create-organization.adoc new file mode 100644 index 000000000..59431e8cf --- /dev/null +++ b/downstream/modules/platform/proc-controller-create-organization.adoc @@ -0,0 +1,51 @@ +[id="proc-controller-create-organization"] + += Creating an organization + +[NOTE] +==== +{ControllerNameStart} automatically creates a default organization. +If you have a Self-support level license, you have only the default organization available and must not delete it. + +You can use the default organization as it is initially set up and edit it later. +==== + +. Click btn:[Add] to create a new organization. ++ +image:organizations-new-organization-form.png[Organizations- new organization form] + +. You can configure several attributes of an organization: + +* Enter the *Name* for your organization (required). +* Enter a *Description* for the organization. +* *Max Hosts* is only editable by a superuser to set an upper limit on the number of license hosts that an organization can have. +Setting this value to *0* signifies no limit. +If you try to add a host to an organization that has reached or exceeded its cap on hosts, an error message displays: ++ +The inventory sync output view also shows the host limit error. ++ +image:organizations-max-hosts-error-output-view.png[Error] ++ +Click btn:[Details] for additional information about the error. ++ +* Enter the name of the *Instance Groups* on which to run this organization. +* Enter the name of the {ExecEnvShort} or search for one that exists on which to run this organization. +For more information, see link:https://docs.ansible.com/automation-controller/4.4/html/upgrade-migration-guide/upgrade_to_ees.html#upgrade-venv[Upgrading to Execution Environments] +* Optional: Enter the *Galaxy Credentials* or search from a list of existing ones. +. Click btn:[Save] to finish creating the organization. + +When the organization is created, {ControllerName} displays the Organization details, and enable you to manage access and {ExecEnvShort} for the organization. + +image:organizations-show-record-for-example-organization.png[Organization details] + +From the *Details* tab, you can edit or delete the organization. + +[NOTE] +==== +If you attempt to delete items that are used by other work items, a message lists the items are affected by the deletion and prompts you to confirm the deletion. +Some screens contain items that are invalid or have been deleted peviously, and will fail to run. +==== + +The following is an example of such a message: + +image:warning-deletion-dependencies.png[Warning] \ No newline at end of file diff --git a/downstream/modules/platform/ref-controller-organization-notifications.adoc b/downstream/modules/platform/ref-controller-organization-notifications.adoc new file mode 100644 index 000000000..ad9a4f4b5 --- /dev/null +++ b/downstream/modules/platform/ref-controller-organization-notifications.adoc @@ -0,0 +1,14 @@ +[id="red-controller-oganization-notifications"] + += Work with Notifications + +Selecting the *Notifications* tab enables you to review any notification integrations you have set up. + +image:organizations-notifications-samples-list.png[Notifications] + +Use the toggles to enable or disable the notifications to use with your particular organization. +For more information, see [Enable and Disable Notifications]. + +If no notifications have been set up, select btn:[Notifications] from the navigation panel. + +For information on configuring notification types, see [Notification Types.] \ No newline at end of file diff --git a/downstream/titles/controller/controller-user-guide/master.adoc b/downstream/titles/controller/controller-user-guide/master.adoc index d5c31adfb..e13027100 100644 --- a/downstream/titles/controller/controller-user-guide/master.adoc +++ b/downstream/titles/controller/controller-user-guide/master.adoc @@ -27,7 +27,7 @@ include::platform/assembly-controller-login.adoc[leveloffset=+1] include::platform/assembly-controller-managing-subscriptions.adoc[leveloffset=+1] include::platform/assembly-controller-user-interface.adoc[leveloffset=+1] include::platform/assembly-controller-search.adoc[leveloffset=+1] -//8 Organizations +include::platform/assembly-controller-organizations.adoc[leveloffset=+1] //9 Users //10 Teams //11 Credentials