Added documentation for FGAC for Flow Framework #8076
Conversation
owaiskazi19
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
Signed-off-by: Owais <[email protected]>
owaiskazi19
force-pushed
the
access-control-ff
branch
from
6514db1 to
c921f11
Compare
| ```json | ||
| PUT _cluster/settings | ||
| { | ||
| "transient": { |
There was a problem hiding this comment.
should this be transient or persistent? This seems appropriate as an example but not sure we want it in the "how to" section without specifying why one or the other.
Reading further this all seems like an example and should have its own "sample" or "example" header.
There was a problem hiding this comment.
This section explains the overall flow with the settings that needs be enabled. Not sure if "example" would the right header here
There was a problem hiding this comment.
I’ll let the doc review address that.
Signed-off-by: Owais <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
| @@ -4,31 +4,31 @@ title: Workflow security | |||
| nav_order: 25 | |||
There was a problem hiding this comment.
Does the navigation looks good @kolchfa-aws ?
There was a problem hiding this comment.
I moved this topic down so it's the last in the left nav.
| @@ -4,31 +4,31 @@ title: Workflow security | |||
| nav_order: 25 | |||
| --- | |||
|
|
|||
| # Flow Framework Security | |||
| # Workflow security | |||
There was a problem hiding this comment.
@dbwiddis Should we keep it as Workflow security or Flow Framework?
There was a problem hiding this comment.
The word "workflow" is commonly used in other places and has led to a lot of confusion. So other than the API and documentation directly relating to it, I'd like to avoid using "workflow".
That said, the left-column header for our plugin is "Automating Configurations" and it seems that may be appropriate as well, although fitting that together with "security" seems awkward.
TLDR: I trust doc writers to pick here. I'm against "Workflow security" and prefer "Flow Framework" if that's the only option, but am very open to other headers.
There was a problem hiding this comment.
I'm equally not sure about the best heading for this topic. I would go with a consistent title "Automating workflows", "Workflow APIs", "Workflow security", etc. But we're already using "Automating configurations" and then everything else mentions "workflows". Adding "Flow Framework" might make the user confused about what we're referencing. That said, I see your point about workflow being a generic concept so I reverted to "Flow Framework security" and added the first sentence that explains that workflows are provided by the Flow Framework plugin. Maybe @natebower can weigh in on this during editorial review.
There was a problem hiding this comment.
I think "Workflow Template Security" might be good?
There was a problem hiding this comment.
I like that! Let me change to "workflow template security"
There was a problem hiding this comment.
@owaiskazi19 @dbwiddis I changed the topic name to "Workflow template security".
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
| * [Delete workflow]({{site.url}}{{site.baseurl}}/automating-configurations/api/delete-workflow/) | ||
|
|
||
| For information about workflow API security, see [Workflow security]({{site.url}}{{site.baseurl}}/automating-configurations/workflow-security/). |
There was a problem hiding this comment.
For information about workflow access control, see...
Signed-off-by: Fanit Kolchina <[email protected]>
kolchfa-aws
added
v2.17.0
release-notes
There was a problem hiding this comment.
@kolchfa-aws @owaiskazi19 Please see my comments and changes and let me know if you have any questions. Thanks!
| * [Delete workflow]({{site.url}}{{site.baseurl}}/automating-configurations/api/delete-workflow/) | ||
|
|
||
| For information about workflow API security, see [Workflow security]({{site.url}}{{site.baseurl}}/automating-configurations/workflow-security/). |
There was a problem hiding this comment.
Do we mean "API workflow security"?
There was a problem hiding this comment.
No, it's "Workflow APIs" https://opensearch.org/docs/latest/automating-configurations/api/index/
There was a problem hiding this comment.
I think it's fine as is. We're not capitalizing the API name if we're referring to the generic concept (of a workflow, in this case).
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
) * Added documentation for FGAC for Flow Framework Signed-off-by: Owais <[email protected]> * Addressed PR comments Signed-off-by: Owais <[email protected]> * Doc review Signed-off-by: Fanit Kolchina <[email protected]> * Code format Signed-off-by: Fanit Kolchina <[email protected]> * Add link on index page Signed-off-by: Fanit Kolchina <[email protected]> * Add link from api page Signed-off-by: Fanit Kolchina <[email protected]> * Change title to flow framework security Signed-off-by: Fanit Kolchina <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> * Changed to workflow template security Signed-off-by: Fanit Kolchina <[email protected]> --------- Signed-off-by: Owais <[email protected]> Signed-off-by: Fanit Kolchina <[email protected]> Signed-off-by: kolchfa-aws <[email protected]> Co-authored-by: Fanit Kolchina <[email protected]> Co-authored-by: kolchfa-aws <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Eric Pugh <[email protected]>
Description
Added documentation for FGAC for Flow Framework.
Reference PR opensearch-project/flow-framework#838
Reference Issue opensearch-project/flow-framework#668
Issues Resolved
List any issues this PR will resolve, e.g. Closes [...].
Version
2.17
Frontend features
If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.