Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

INF-2227: Add documentation for COManage CO Group provisioning. #144

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

williamnswanson
Copy link
Contributor

No description provided.

@williamnswanson williamnswanson self-assigned this Aug 16, 2024
@williamnswanson williamnswanson marked this pull request as ready for review August 16, 2024 21:16
@williamnswanson williamnswanson added the documentation Improvements or additions to documentation label Aug 20, 2024
Copy link
Contributor

@mwestphall mwestphall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was able to follow this document to add a new COManage Group, looks good.

Copy link
Contributor

@brianhlin brianhlin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've got thoughts on formatting but will have to provide details at a later time

Copy link
Contributor

@brianhlin brianhlin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See in-line comments. Mostly nit-picky stuff to adhere to our style guide: https://osg-htc.org/technology/documentation/style-guide/. Make sure to batch commits together when accepting suggestions (https://osg-htc.org/technology/software/git-software-development/#batch-commits-when-accepting-suggestions-from-a-review)

Also as a heads up, you should basically never submit PRs from your main / master branches as the default PR behavior is to allow the maintainer to add commits to your PR, i.e. your fork's main / master branch


### Provisioning a CO Group in COManage
In order for a CO Group from COManage to show up in LDAP (and thus be made available for reference on Hosts),
it must first be provisioned.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
it must first be provisioned.
it must first be provisioned.

You don't need the leading space here as the newline will be replaced by a space (unless there are multiple newlines)

@@ -0,0 +1,71 @@
COManage Recipes
==============================
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
==============================
================

Just for visual alignment of the article title

COManage Recipes
==============================

A collection of step-by-step instructions for common actions for use by administrators of the OSG COManage.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
A collection of step-by-step instructions for common actions for use by administrators of the OSG COManage.
A collection of step-by-step instructions for OSG COmanage administrators.

Just a little bit of brevity here. Also, the appropriate capitalization is COmanage

@@ -0,0 +1,71 @@
COManage Recipes
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
COManage Recipes
COmanage Recipes

Comment on lines +7 to +9
Steps for Common COManage Actions
----
This section contains some common actions administrators perform on the OSG COManage, and how to do so.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Steps for Common COManage Actions
----
This section contains some common actions administrators perform on the OSG COManage, and how to do so.

All of this basically just repeats what you say in the sentence above. Also, adding a section level here adds noise to the section hierarchy and it's not entirely clear why we need it (if we have another section in this doc at the same level, what would it actually be?)

Comment on lines +58 to +60
- On COManage, navigate to `Configuration` -> `Clusters` -> `Configure` -> `Manage Unix Cluster Groups`
-> `+ Add Unix Cluster Group`
- Select the name of the Group you are trying to provision from the drop-down menu, then click `ADD`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- On COManage, navigate to `Configuration` -> `Clusters` -> `Configure` -> `Manage Unix Cluster Groups`
-> `+ Add Unix Cluster Group`
- Select the name of the Group you are trying to provision from the drop-down menu, then click `ADD`
1. On COManage, navigate to `Configuration` -> `Clusters` -> `Configure` -> `Manage Unix Cluster Groups`
-> `+ Add Unix Cluster Group`
1. Select the name of the Group you are trying to provision from the drop-down menu, then click `ADD`


![Create-Unix-Cluster-Group](../img/comanage-create-unix-cluster-group.png)

1. #### Provision group
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. #### Provision group
### Provision group

Comment on lines +66 to +71
- In the `PROVISIONED SERVICES` tab of the Edit page for the Group,
click the `⚙ Provision` button, then on `Provision`.

![Provision-Group](../img/comanage-group-provision.png)

If all prior steps have been completed, you should get a message that the Group was successfully provisioned.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- In the `PROVISIONED SERVICES` tab of the Edit page for the Group,
click the `⚙ Provision` button, then on `Provision`.
![Provision-Group](../img/comanage-group-provision.png)
If all prior steps have been completed, you should get a message that the Group was successfully provisioned.
In the `PROVISIONED SERVICES` tab of the Edit page for the Group, click the `⚙ Provision` button, then on `Provision`.
![Provision-Group](../img/comanage-group-provision.png)
If all prior steps have been completed, you should get a message that the Group was successfully provisioned.

There aren't multiple actions to take here so you don't need to toss this under a list

This section contains some common actions administrators perform on the OSG COManage, and how to do so.

### Provisioning a CO Group in COManage
In order for a CO Group from COManage to show up in LDAP (and thus be made available for reference on Hosts),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In order for a CO Group from COManage to show up in LDAP (and thus be made available for reference on Hosts),
In order for a CO Group from COManage to show up in LDAP (and thus be made available for reference on hosts),

Adding a linebreak between the heading and content for readability, not sure why hosts was capitalized


### Provisioning a CO Group in COManage
In order for a CO Group from COManage to show up in LDAP (and thus be made available for reference on Hosts),
it must first be provisioned.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it'd be worth adding an admonition here to speak to the fact that OIDC clients needing groups don't need any of these steps outside of the group creation (see https://osg-htc.org/technology/documentation/style-guide/#notes and https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants