Adding IAM Actions doc #3157
Adding IAM Actions doc #3157
Conversation
|
see rel-eng #1064 |
mjingle
force-pushed
the
mj/ChartingTasks
branch
from
10b6afb to
ba0fe51
Compare
| | View Events | Dashboards | event:* | /event_feed | https://{{< example_fqdn "automate" >}}/dashboards/event-feed | | ||
| | View Service Group Data | Applications | applications:* | /applications/service-groups | https://{{< example_fqdn "automate" >}}/applications/service-groups | | ||
| | View Client Runs | Infrastructure | infra:nodes:* | /cfgmgmt/nodes | https://{{< example_fqdn "automate" >}}/infrastructure/client-runs | | ||
| | Manage Chef Servers | Infrastructure | infra:servers:* | <endpoint> | https://{{< example_fqdn "automate" >}}/infrastructure/chef-servers | |
There was a problem hiding this comment.
Currently under a feature flag. API details not developed yet.
There was a problem hiding this comment.
weve got a product named manage, wonder if the use of this word might confuse folks?
There was a problem hiding this comment.
Fair point. Let's see if we can find a good synonym for "Manage".
There was a problem hiding this comment.
The description for this page in the browser says "Manage Chef Servers with Chef Automate," but context is really important. Thank you @susanev for catching that.
Would "View Chef Servers" work instead in the meantime? I'm basing this on how Client Runs has "View Client Runs" and Client Runs is listed with Chef Servers in the same Infrastructure section.
There was a problem hiding this comment.
you cant edit anything for chef servers right now, so i think view works
There was a problem hiding this comment.
but my comment was about the use of manage across this page, not just here for chef servers
There was a problem hiding this comment.
We're exploring this more, but I'm not sure that we can give up the word 'manage'--which accurately denotes the API actions-- because of the (deprecated) existence of Chef Manage. Changing some to add or edit X and keeping manage on those things that have parity with Chef Manage is also confusing for users.
There was a problem hiding this comment.
Pretty good! When you have to choose between hewing closer to the headings or the page content, the preference should be towards the header. The exception, of course, is if the information in the page content is vital. In that case, we should look first at revising the header.
mjingle
force-pushed
the
mj/ChartingTasks
branch
3 times, most recently
from
2cd7dbc to
45d5d89
Compare
| | View Chef Servers | Infrastructure | infra:servers:* | <endpoint> | https://{{< example_fqdn "automate" >}}/infrastructure/chef-servers | | ||
| | List Reports | Compliance | compliance:reporting:* | /compliance/reporting/reports | https://{{< example_fqdn "automate" >}}/compliance/reports/overview | | ||
| | List Scan Jobs | Compliance | compliance:scannerJobs:* | /compliance/scanner/jobs | https://{{< example_fqdn "automate" >}}/compliance/scan-jobs/jobs | | ||
| | Add or Edit Scan Jobs | Compliance | [compliance:scannerJobs:* , infra:nodes:* , infra:nodeManagers:* , compliance:profiles:* ] | /compliance/scanner/jobs | https://{{< example_fqdn "automate" >}}/compliance/scan-jobs/jobs | |
There was a problem hiding this comment.
@susanev How does this change through the document look?
There was a problem hiding this comment.
the * gives list, get, create, delete permissions so i think its a bit misleading, but i also understand yall are trying to highlight what is currently possible. so mixed feelings i guess. i would not try and block this from merging though. we could try this out and see if we get user feedback and adjust from there.
There was a problem hiding this comment.
That's why we prefer 'manage'; it implies the whole scope of actions.
There was a problem hiding this comment.
so they would all say manage?
There was a problem hiding this comment.
Everything from line 28 to line 40 would say "manage" rather than "add or edit" in this case.
mjingle
force-pushed
the
mj/ChartingTasks
branch
from
45d5d89 to
a26f7b2
Compare
Signed-off-by: Mary Jinglewski <[email protected]>
Signed-off-by: Mary Jinglewski <[email protected]>
Signed-off-by: Mary Jinglewski <[email protected]>
Signed-off-by: Mary Jinglewski <[email protected]>
Signed-off-by: Mary Jinglewski <[email protected]>
Signed-off-by: Mary Jinglewski <[email protected]>
Signed-off-by: Mary Jinglewski <[email protected]>
Signed-off-by: Mary Jinglewski <[email protected]>
mjingle
force-pushed
the
mj/ChartingTasks
branch
from
5305eb8 to
3bf6ca5
Compare
Signed-off-by: Mary Jinglewski <[email protected]>
Signed-off-by: Mary Jinglewski <[email protected]>
Signed-off-by: Mary Jinglewski [email protected]
🔩 Description: What code changed, and why?
To meet a documentation need for support and customers, we're adding a chart of IAM Actions, their end points, and their associated UI page to the Chef Automate docs site.
Related Resources
https://github.com/chef/release-engineering/issues/1064
👍 Definition of Done
PR should be done when the details of this current chart are filled out as much as possible. @mjingle still needs to do a second run-through.
👟 How to Build and Test the Change
To view the docs change, pull in this PR and follow the instructions for
make serve.✅ Checklist