Skip to content

Commit

Permalink
Merge pull request #199 from adonispuente/workspace
Browse files Browse the repository at this point in the history
feat(RHINENG-10919): Update Groups to Workspaces
  • Loading branch information
Hyperkid123 authored Jun 28, 2024
2 parents 945d959 + 2b6a232 commit 92e3e7f
Show file tree
Hide file tree
Showing 4 changed files with 65 additions and 65 deletions.
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Additional info: https://docs.openshift.com/container-platform/4.9/web_console/creating-quick-start-tutorials.html
metadata:
name: insights-inventory-groups-rbac
name: insights-inventory-workspace-rbac
# you can add additional metadata here
instructional: true
spec:
displayName: Managing user access with Inventory groups
displayName: Managing user access with Inventory Workspaces
durationMinutes: 5
# Optional type section, will display as a tile on the card
type:
Expand All @@ -14,25 +14,25 @@ spec:
icon: data:image/svg+xml;base64,PCEtLSBHZW5lcmF0ZWQgYnkgSWNvTW9vbi5pbyAtLT4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIj4KPHRpdGxlPjwvdGl0bGU+CjxnIGlkPSJpY29tb29uLWlnbm9yZSI+CjwvZz4KPHBhdGggZD0iTTQ0OCA2NHY0MTZoLTMzNmMtMjYuNTEzIDAtNDgtMjEuNDktNDgtNDhzMjEuNDg3LTQ4IDQ4LTQ4aDMwNHYtMzg0aC0zMjBjLTM1LjE5OSAwLTY0IDI4LjgtNjQgNjR2Mzg0YzAgMzUuMiAyOC44MDEgNjQgNjQgNjRoMzg0di00NDhoLTMyeiI+PC9wYXRoPgo8cGF0aCBkPSJNMTEyLjAyOCA0MTZ2MGMtMC4wMDkgMC4wMDEtMC4wMTkgMC0wLjAyOCAwLTguODM2IDAtMTYgNy4xNjMtMTYgMTZzNy4xNjQgMTYgMTYgMTZjMC4wMDkgMCAwLjAxOS0wLjAwMSAwLjAyOC0wLjAwMXYwLjAwMWgzMDMuOTQ1di0zMmgtMzAzLjk0NXoiPjwvcGF0aD4KPC9zdmc+Cg==
prerequisites:
- Be an Organization Administrator or have the User Access Administrator role
- Have Inventory Groups created
- Have Inventory workspaces created
description: |-
Learn how to manage access to your systems using Inventory groups
Learn how to manage access to your systems using Inventory Workspaces
introduction: |-
**Welcome to the quick start for managing user access using Inventory groups. Use this feature to enhance security within your organization.**
**Welcome to the quick start for managing user access using Inventory Workspaces. Use this feature to enhance security within your organization.**
In this quick start, you will use the User Access application to configure access to different Inventory groups using custom role functionality and user access groups.
In this quick start, you will use the User Access application to configure access to different inventory workspaces using custom role functionality and user access groups.
<br> <br>
**IMPORTANT NOTE:** By default, everyone in your organization will be assigned the "Inventory Hosts Administrator" role, and will have access to all systems, whether they are grouped or not. You will change these default permissions by completing the tasks in this quick Start.
**IMPORTANT NOTE:** By default, everyone in your organization will be assigned the "Inventory Hosts Administrator" role, and will have access to all systems, whether they are in a workspace or not. You will change these default permissions by completing the tasks in this quick Start.
Use this quick start to assign user-specific access to:
- Certain groups of systems but not others, and/or
- Certain workspaces but not others, and/or
- All ungrouped systems
tasks:
- title: Create a custom role
description: |-
Configuring user access for your group must be done from the User Access application.
Configuring user access for your workspace must be done from the User Access application.
**To create a custom role:**
Expand All @@ -44,28 +44,28 @@ spec:
1. On Step 2 (Add permissions), filter by Applications, and select “inventory” to narrow down all inventory permissions.
**The four inventory permissions include:** <br>
1. **inventory:hosts:read** → Allows users to view systems (needed to view systems both inside and outside a group).
1. **inventory:hosts:read** → Allows users to view systems (needed to view systems both inside and outside a workspace).
1. **inventory:hosts:write** → Allows users to Rename or Delete systems.
1. **inventory:groups:read** → Allows users to view Groups, and general info (not including systems in it).
1. **inventory:group:write** → Allows users to edit inventory group membership (add and remove systems from groups).
1. **inventory:workspaces:read** → Allows users to view workspaces, and general info (not including systems in it).
1. **inventory:workspace:write** → Allows users to edit inventory workspace membership (add and remove systems from workspaces).
1. Select inventory permissions as needed. Here are some possible variations: <br>
- If you want to give a user full access to the group and its systems → select all 4 permissions.
- If you want to give a user full access to the systems inside a group → but not group editing access, give them inventory:hosts:read, inventory:hosts:write, and inventory:group:read, but NOT inventory:group:write.
- If you want to give a user full access to ungrouped systems → select all 4 permissions (ungrouped systems are considered a group).
- If you want to give a user full access to the workspace and its systems → select all 4 permissions.
- If you want to give a user full access to the systems inside a workspace → but not workspace editing access, give them inventory:hosts:read, inventory:hosts:write, and inventory:workspace:read, but NOT inventory:workspace:write.
- If you want to give a user full access to ungrouped systems → select all 4 permissions (ungrouped systems are considered a workspace).
1. Click **Next**.
1. On Step 3 (Define inventory group access), for each permission, select groups you would like to apply the permissions to using the dropdown menus. <br>
1. On Step 3 (Define inventory workspace access), for each permission, select workspaces you would like to apply the permissions to using the dropdown menus. <br>
Possible scenarios include:
- You would like to give users the ability to only see systems in specific groups and NOT ungrouped systems → Select those groups only.
- You would like to give users the ability to see systems in specific groups AND any ungrouped systems → Select those groups for all permissions AND “ungrouped systems" for inventory:hosts permissions.
- You would like to give users the ability to only see systems in specific workspaces and NOT ungrouped systems → Select those workspaces only.
- You would like to give users the ability to see systems in specific workspaces AND any ungrouped systems → Select those workspaces for all permissions AND “ungrouped systems" for inventory:hosts permissions.
- You would like to give users the ability to see everything in the inventory → There is no need to create a custom role then. You can cancel the creation flow.
1. Once you’ve made your selections, click **Next**.
1. Review your selections. Click **Submit**.
Repeat this process for every Inventory group or groups of users you want to give specific group access to.
Repeat this process for every inventory workspace or group of users you want to give specific workspace access to.
**NOTE:** If you want to give a group of system administrators all the same access to groups A, B, and C, you can create a single custom role and assign permissions to those 3 groups.
However, if you want to give different users access to different groups, you will need to create multiple custom roles - one for each group you would like to give access to.
**NOTE:** If you want to give a group of system administrators all the same access to workspaces A, B, and C, you can create a single custom role and assign permissions to those 3 workspaces.
However, if you want to give different users access to different workspaces, you will need to create multiple custom roles - one for each workspace you would like to give access to.
# optional - the task's Check your work module
Expand All @@ -81,7 +81,7 @@ spec:
- title: Create a User Access group
description: |-
To assign custom roles to a user or group of users, you must create a User Access group and place the corresponding role and users inside it. The users inside a group will be given the roles inside the group.
To assign custom roles to a user or group of users, you must create a User Access group. The users inside a group will be given the roles inside the group.
1. Click User Access > **Groups** in the left navigation.
1. Click **Create group**.
Expand Down Expand Up @@ -110,7 +110,7 @@ spec:
After completing the tasks this far, all users in your organization will still have full access to your inventory because they still have the “Inventory Hosts Administrator” role assigned to them. This allows them to view and edit all hosts. This role is given to them by the default “Default Access” group which assigns roles to your whole organization.
<br><br>
**To make sure your organization users' access is limited to the inventory groups/systems defined in your custom roles, you must remove the “Inventory Hosts Administrator” role from your users.**
**To make sure your organization users' access is limited to the inventory workspaces/systems defined in your custom roles, you must remove the “Inventory Hosts Administrator” role from your users.**
<br><br>
To do this:
1. In the User Access > Groups page, click the **Default Access group**.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
kind: QuickStarts
name: insights-inventory-groups-rbac
name: insights-inventory-workspace-rbac
tags:
- kind: bundle
value: insights
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Additional info: https://docs.openshift.com/container-platform/4.9/web_console/creating-quick-start-tutorials.html
metadata:
name: insights-inventory-groups
name: insights-inventory-workspace
# you can add additional metadata here
instructional: true
spec:
displayName: Creating and managing Inventory groups
displayName: Creating and managing Inventory Workspaces
durationMinutes: 5
# Optional type section, will display as a tile on the card
type:
Expand All @@ -13,25 +13,25 @@ spec:
color: grey
icon: data:image/svg+xml;base64,PCEtLSBHZW5lcmF0ZWQgYnkgSWNvTW9vbi5pbyAtLT4KPHN2ZyB2ZXJzaW9uPSIxLjEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgd2lkdGg9IjUxMiIgaGVpZ2h0PSI1MTIiIHZpZXdCb3g9IjAgMCA1MTIgNTEyIj4KPHRpdGxlPjwvdGl0bGU+CjxnIGlkPSJpY29tb29uLWlnbm9yZSI+CjwvZz4KPHBhdGggZD0iTTQ0OCA2NHY0MTZoLTMzNmMtMjYuNTEzIDAtNDgtMjEuNDktNDgtNDhzMjEuNDg3LTQ4IDQ4LTQ4aDMwNHYtMzg0aC0zMjBjLTM1LjE5OSAwLTY0IDI4LjgtNjQgNjR2Mzg0YzAgMzUuMiAyOC44MDEgNjQgNjQgNjRoMzg0di00NDhoLTMyeiI+PC9wYXRoPgo8cGF0aCBkPSJNMTEyLjAyOCA0MTZ2MGMtMC4wMDkgMC4wMDEtMC4wMTkgMC0wLjAyOCAwLTguODM2IDAtMTYgNy4xNjMtMTYgMTZzNy4xNjQgMTYgMTYgMTZjMC4wMDkgMCAwLjAxOS0wLjAwMSAwLjAyOC0wLjAwMXYwLjAwMWgzMDMuOTQ1di0zMmgtMzAzLjk0NXoiPjwvcGF0aD4KPC9zdmc+Cg==
description: |-
Learn how to create an Inventory group, add systems to it, and remove systems from it.
Learn how to create an inventory workspace, add systems to it, and remove systems from it.
introduction: |-
**Welcome to the quick start for creating and managing your systems using Inventory groups. In this quick start, you will:**
- Create an Inventory group.
- Learn to add systems to the group.
- Learn how to remove systems from the group.
**Welcome to the quick start for creating and managing your systems using Inventory Workspaces. In this quick start, you will:**
- Create an Inventory workspace.
- Learn to add systems to the workspace.
- Learn how to remove systems from the workspace.
tasks:
- title: Create a group
- title: Create a workspace
description: |-
Inventory Groups allow you to create groups, and select specific systems to add to these groups to better organize your Inventory.
Inventory Workspaces allows you to create workspaces, and select specific systems to add to these workspaces to better organize your Inventory.
**To create an Inventory group:**
**To create an inventory workspace:**
1. Navigate to Inventory > **Groups** using the left navigation.
2. Click the **Create group** button.
3. In the Create group modal, enter a name for the group.
1. Navigate to Inventory > **Workspaces** using the left navigation.
2. Click the **Create workspace** button.
3. In the Create workspace modal, enter a name for the workspace.
4. Click **Submit**.
# optional - the task's Check your work module
Expand All @@ -44,43 +44,43 @@ spec:
success: Shows a success message in the task header
failed: Shows a failed message in the task header

- title: Add systems to a group
- title: Add systems to a workspace
description: |-
There are two ways to add systems to a group; you can either do it from the Group's page or from the main Systems page.
There are two ways to add systems to a workspace; you can either do it from the workspace's page or from the main Systems page.
**To add systems to a group from the Group's page:**
**To add systems to a workspace from the workspace's page:**
1. From the main Groups page, click into a group of choice, to navigate to its page.
1. Click **Add systems** once on the group's page. This should open up a modal.
1. Select systems to add to your group using the checkboxes. You may filter through systems using the filter toolbar.
1. From the main Workspaces page, click into a workspace of choice, to navigate to its page.
1. Click **Add systems** once on the workspace's page. This should open up a modal.
1. Select systems to add to your workspace using the checkboxes. You may filter through systems using the filter toolbar.
1. Click **Submit**.
To add systems to other groups, navigate back to the main Groups page, click into another group and repeat these steps.
To add systems to other workspaces, navigate back to the main Workspaces page, click into another workspace and repeat these steps.
**To add systems to a group from the main Systems page:**
**To add systems to a workspace from the main Systems page:**
1. Navigate to Inventory > **Systems** using the left navigation.
1. Select systems you want to add to a group.
1. Select systems you want to add to a workspace.

- **To add individual systems to a group**, click on <i class="fas fa-ellipsis-v"></i> in the row level , then click **Add to group**.
- **To add individual systems to a workspace**, click on <i class="fas fa-ellipsis-v"></i> in the row level , then click **Add to workspace**.

- **To add multiple systems to a group**, select multiple systems using the table checkboxes, Click on <i class="fas fa-ellipsis-v"></i> in the toolbar, then click on **Add to group**.
- **To add multiple systems to a workspace**, select multiple systems using the table checkboxes, Click on <i class="fas fa-ellipsis-v"></i> in the toolbar, then click on **Add to workspace**.

**NOTE**: Selecting systems that already belong to a group will disable the action.
**NOTE**: Selecting systems that already belong to a workspace will disable the action.

1. In the add to group modal, you can either select an existing group, or create a new group (if you have permissions to do so).
1. In the add to workspace modal, you can either select an existing workspace, or create a new workspace (if you have permissions to do so).

- **To add to an existing group:**
1. Select a group from the dropdown menu.
- **To add to an existing workspace:**
1. Select a workspace from the dropdown menu.
1. click **Add** to submit.

- **To add to a new group:**
1. Click **Create a new group**.
1. Enter a group name.
- **To add to a new workspace:**
1. Click **Create a new workspace**.
1. Enter a workspace name.
1. Click **Create**.
1. Open the Select a group dropdown, and select your new group.
1. Open the Select a workspace dropdown, and select your new workspace.
1. Click **Add**.

# optional - the task's Check your work module
Expand All @@ -93,19 +93,19 @@ spec:
success: Shows a success message in the task header
failed: Shows a failed message in the task header

- title: Remove systems from a group
- title: Remove systems from a workspace
description: |-
**To remove systems from a group from the Group's page:**
**To remove systems from a workspace from the workspace's page:**
1. Navigate to Inventory > **Groups** using the left navigation.
1. Select systems you want to remove from a group.
1. Navigate to Inventory > **Workspaces** using the left navigation.
1. Select systems you want to remove from a workspace.
- **To remove individual systems from a group**, click on <i class="fas fa-ellipsis-v"></i> in the row level, then click **Remove from group**.
- **To remove individual systems from a workspace**, click on <i class="fas fa-ellipsis-v"></i> in the row level, then click **Remove from workspace**.
- **To remove multiple systems from a group**, select multiple systems using the table checkboxes, Click on <i class="fas fa-ellipsis-v"></i> in the toolbar, then click on **Remove from group**.
- **To remove multiple systems from a workspace**, select multiple systems using the table checkboxes, Click on <i class="fas fa-ellipsis-v"></i> in the toolbar, then click on **Remove from workspace**.
**NOTE**: Selecting systems that already belong to a group will disable the action.
**NOTE**: Selecting systems that already belong to a workspace will disable the action.


1. A modal will open. Click **Remove**.
Expand All @@ -128,4 +128,4 @@ spec:
# you can link to the next quick start(s) here
nextQuickStart:
- insights-inventory-groups-rbac
- insights-inventory-workspace-rbac
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
kind: QuickStarts
name: insights-inventory-groups
name: insights-inventory-workspace
tags:
- kind: bundle
value: insights
Expand Down

0 comments on commit 92e3e7f

Please sign in to comment.