Managing user access in Private Automation Hub
Create groups for your automation hub users to provide them with appropriate system permissions, or allow view-only access to unauthorized users.
Abstract
Preface
Configure user access in Automation Hub to provide the appropriate level of system permissions to groups in your organization, or provide view-only access to unauthorized users.
Making open source more inclusive
Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright’s message.
Chapter 1. Configuring user access for your local Automation Hub
1.1. About user access
You can manage user access to content and features in automation hub by creating groups of users that have specific permissions.
1.1.1. How to implement user access
User access is based on managing permissions to system objects (users, groups, namespaces) rather than by assigning permissions individually to specific users.
You assign permissions to the groups you create. You can then assign users to these groups. This means that each user in a group has the permissions assigned to that group.
Groups created in automation hub can range from system administrators responsible for governing internal collections, configuring user access, and repository management to groups with access to organize and upload internally developed content to automation hub.
- See Automation Hub permissions for information on system permissions.
1.1.2. Default user access
When you install automation hub, the default admin user is created in the Admin group. This group is assigned all permissions in the system.
1.1.3. Getting started
Log in to your local automation hub using credentials for the admin user configured during installation.
The following sections describe the workflows associated with organizing your users who will access Automation Hub and providing them with required permissions to reach their goals. See the permissions reference table for a full list and description of all permissions available.
1.2. Creating a new group
You can create and assign permissions to a group in automation hub that enables users to access specified features in the system. By default, there is an admins group in automation hub that has all permissions assigned and is available on initial login with credentials created when installing automation hub.
Prerequisites
- You have groups permissions and can create and manage group configuration and access in automation hub.
Procedure
- Log in to your local automation hub.
- Navigate to → .
- Click .
- Provide a Name and click .
You can now assign permissions and add users on the group edit page.
1.3. Assigning permissions to groups
You can assign permissions to groups in automation hub that enable users to access specific features in the system. By default, new groups do not have any assigned permissions. You can add permissions upon initial group creation or edit an existing group to add or remove permissions
Prerequisites
- You have Change group permissions and can edit group permissions in automation hub.
Procedure
- Log in to your local automation hub.
- Navigate to → .
- Click .
- Click in the name field and fill in the role name.
- Click in the description field and fill in the description.
- Complete the Permissions section.
- Click in the field for each permission type and select permissions that appear in the list.
- Click when finished assigning permissions.
- Navigate to → .
- Click on a group name.
- Click on the Access tab.
- Click .
- Select the role created in step 8.
- Click to confirm the selected role.
- Click to complete adding the role.
The group can now access features in automation hub associated with their assigned permissions.
1.4. Creating a new user
You can create a user in automation hub and add them to groups that can access features in the system associated by the level of assigned permissions.
Prerequisites
- You have user permissions and can create users in automation hub.
Procedure
- Log in to your local automation hub.
- Go to .
- Click .
- Provide information in each of the fields. Username and Password are required.
- [Optional] Assign the user to a group by clicking in the Groups field and selecting from the list of groups.
- Click .
The new user will now appear in the list on the Users page.
1.5. Creating a super user
You can create a super user in automation hub and spread administration work across your team.
Prerequisites
- You have Super user permissions and can create users in automation hub.
Procedure
- Log in to your local automation hub.
- Go to .
- Click .
- Select the user you want to be a super user to see the User details page.
- Select Super User under User type.
The user now has Super user permissions.
1.6. Adding users to groups
You can add users to groups when creating a group or manually add users to existing groups. This section describes how to add users to an existing group.
Prerequisites
- You have groups permissions and can create and manage group configuration and access in automation hub.
Procedure
- Log in to automation hub.
- Navigate to → .
- Click on a Group name.
- Navigate to the tab, then click .
- Select users to add from the list and click .
You have added the users you selected to the group. These users now have permissions to use automation hub assigned to the group.
1.7. Creating a new group for content curators
You can create a new group in automation hub designed to support content curation in your organization that contributes internally developed collections for publication in automation hub.
This section shows you how to create a new group and assign the required permissions to help content developers create namespaces and upload their collections to automation hub.
Prerequisites
- You have administrative permissions in automation hub and create groups.
Procedure
- Log in to your local automation hub.
- Navigate to and click .
- Enter Content Engineering as a Name for the group in the modal and click . You have created the new group and the Groups page appears.
- On the Permissions tab, click .
- Under Namespaces, add permissions for Add Namespace, Upload to Namespace and Change Namespace.
Click
.The new group is created with the permissions you assigned. You can then add users to the group.
- Click the Users tab on the Groups page.
- Click .
- Select users from the modal and click .
Conclusion
You now have a new group who can use automation hub to:
- Create a namespace.
- Edit the namespace details and resources page.
- Upload internally developed collections to the namespace.
1.8. automation hub permissions
Permissions provide a defined set of actions each group performs on a given object. Determine the required level of access for your groups based on the following permissions:
Object | Permission | Description |
---|---|---|
collection namespaces | Add namespace Upload to namespace Change namespace Delete namespace | Groups with these permissions can create, upload collections, or delete a namespace. |
collections | Modify Ansible repo content Delete collections | Groups with this permission can move content between repositories using the Approval feature, certify or reject features to move content from the staging to published or rejected repositories, abd delete collections. |
users | View user Delete user Add user Change user | Groups with these permissions can manage user configuration and access in automation hub. |
groups | View group Delete group Add group Change group | Groups with these permissions can manage group configuration and access in automation hub. |
collection remotes | Change collection remote View collection remote | Groups with these permissions can configure remote repository by navigating to → . |
containers | Change container namespace permissions Change containers Change image tags Create new containers Push to existing containers Delete container repository | Groups with these permissions can manage container repositories in automation hub. |
remote registries | Add remote registry Change remote registry Delete remote registry | Groups with these permissions can add, change, or delete remote registries added to automation hub. |
task management | Change task Delete task View all tasks | Groups with these permissions can manage tasks added to Task Management in automation hub. |
1.9. Deleting a user from automation hub
When you delete a user account, the name and email of the user are permanently removed from automation hub.
Prerequisites
- You have user permissions in automation hub.
Procedure
- Log in to automation hub.
- Expand .
- Click to display a list of the current users.
-
Click the
icon beside the user that you want to remove, then click .
- Click in the warning message to permanently delete the user.
Chapter 2. Enabling view-only access for your private automation hub
By enabling view-only access, you can grant access for users to view collections or namespaces on your private automation hub without the need for them to log in. View-only access allows you to share content with unauthorized users while restricting their ability to only view or download source code, without permissions to edit anything on your private automation hub.
Enable view-only access for your private automation hub by editing the inventory file found on your Red Hat Ansible Automation Platform installer.
-
If you are installing a new instance of Ansible Automation Platform, follow these steps to add the
automationhub_enable_unauthenticated_collection_access
andautomationhub_enable_unauthenticated_collection_download
parameters to yourinventory
file along with your other installation configurations: -
If you are updating an existing Ansible Automation Platform installation to include view-only access, add the
automationhub_enable_unauthenticated_collection_access
andautomationhub_enable_unauthenticated_collection_download
parameters to yourinventory
file then run thesetup.sh
script to apply the updates:
Procedure
Navigate to the installer.
- Bundled installer
$ cd ansible-automation-platform-setup-bundle-<latest-version>
- Online installer
$ cd ansible-automation-platform-setup-<latest-version>
-
Open the
inventory
file with a text editor. Add the
automationhub_enable_unauthenticated_collection_access
andautomationhub_enable_unauthenticated_collection_download
parameters to the inventory file and set both toTrue
, following the example below:[all:vars] automationhub_enable_unauthenticated_collection_access = True 1 automationhub_enable_unauthenticated_collection_download = True 2
-
Run the
setup.sh
script. The installer will now enable view-only access to your automation hub.
Verification
Once the installation completes, you can verify that you have view-only access on your private automation hub by attempting to view content on your automation hub without logging in.
- Navigate to your private automation hub.
- On the login screen, click .
Verify that you are able to view content on your automation hub, such as namespaces or collections, without having to log in.