Skip to content

Commit

Permalink
Create 'Organizations' section of Controller UG (#425)
Browse files Browse the repository at this point in the history
* Create 'Organizations' section of Controller UG

Created modules

Create Section 8 of the Controller user Guide

https://issues.redhat.com/browse/AAP-15675

* Create 'Organizations' section

Add missing file

Create Section 8 of the Controller user Guide

https://issues.redhat.com/browse/AAP-15675

* Create 'Organizations' setion

Corrected master.adoc

Create Section 8 of the Controller user Guide

https://issues.redhat.com/browse/AAP-15675

* Create 'Organizations' section

Corrections

Create Section 8 of the Controller user Guide

https://issues.redhat.com/browse/AAP-15675

* Create 'Organizations' section

Added image

Create Section 8 of the Controller user Guide

https://issues.redhat.com/browse/AAP-15675

* Create 'Organizations' section

Added icon.

Create Section 8 of the Controller user Guide

https://issues.redhat.com/browse/AAP-15675

* Create 'Organizations' section

Addressed comments

Create Section 8 of the Controller user Guide

https://issues.redhat.com/browse/AAP-15675
  • Loading branch information
ianf77 authored Sep 19, 2023
1 parent 538c694 commit 6bd5083
Show file tree
Hide file tree
Showing 16 changed files with 152 additions and 2 deletions.
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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]
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[]

Binary file added downstream/images/disassociate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -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]

Original file line number Diff line number Diff line change
@@ -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.




Original file line number Diff line number Diff line change
@@ -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]
Original file line number Diff line number Diff line change
@@ -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.]
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 6bd5083

Please sign in to comment.