[Playground] Adds revised PLAYGROUND_SHORT_TERM_DESIGN.md to the repo #22
Conversation
Signed-off-by: Huy Nguyen <[email protected]>
DESIGN.md
Outdated
|
|
||
| ## Proposal | ||
|
|
||
| To address this need, a demo website we call Playground was proposed that |
There was a problem hiding this comment.
Could you please normalize the name which comments in the issue? #9 (comment)
There was a problem hiding this comment.
Done, the demo site is now named as "OpenSearch Playground."
There was a problem hiding this comment.
I also added some more information taken from the team review.
There was a problem hiding this comment.
This is design based on short term, can we add some information for the title and design content. thanks
There was a problem hiding this comment.
Could you please change the file to PLAYGROUND_SHORT_TERM_DESIGN.md ? we will add PLAYGROUND_LONG_TERM_DESIGN.md later on.
There was a problem hiding this comment.
Done. Are there any more changes I should make before I commit my changes?
There was a problem hiding this comment.
Thanks. All looks good to me.
There was a problem hiding this comment.
@huyaboo would you work with @Flyingliuhub to determine what's right location for this doc
by following below guide
https://github.com/opensearch-project/dashboards-anywhere/blob/main/docs/DOCUMENTATION_GUIDE.md
|
@huyaboo Please follow this guide to save you design doc https://github.com/opensearch-project/dashboards-anywhere/blob/main/docs/DOCUMENTATION_GUIDE.md, and make a good name instead of DESIGN.md |
There was a problem hiding this comment.
@huyaboo DESIGN.md - name is too generic, could you please provide a good name? thanks
Can you provide more detail in the Description? Thanks |
docs/playground/DESIGN.md
Outdated
| @@ -0,0 +1,225 @@ | |||
| [-](url) Start Date: 2022-06-09 | |||
There was a problem hiding this comment.
Please remove additional space here. thanks
docs/playground/DESIGN.md
Outdated
| opendistro_security_anonymous: | ||
| reserved: true | ||
| cluster_permissions: | ||
| - 'cluster_monitor' |
There was a problem hiding this comment.
what's kind of permission here for cluster_monitor ?
There was a problem hiding this comment.
This permission was required so that the user in Dev Tools can make some queries like GET _cat/indices.
There was a problem hiding this comment.
https://github.com/opensearch-project/security/blob/d0e06aa3def41402c121963e74147e40d1246741/src/test/resources/legacy/securityconfig_v6/migration/action_groups.yml#L109, you are give all the permission under cluster_monitor. as I said the previous comments, this is design doc, not implement document. you still need to add helm's opensearch and opensearch dashboard to config folder and it will be used for deployment.
There was a problem hiding this comment.
So do I just delete the sample configurations for all my files? I understand that this document is for design and so that is why I just outlined some changes I have made.
docs/playground/DESIGN.md
Outdated
| - 'indices:monitor/settings/get' | ||
| - 'indices:monitor/stats' | ||
| - 'indices:data/read*' | ||
| - 'indices:admin/get' |
There was a problem hiding this comment.
where is the sample data indices permission? you need to add all the configuration file to different PR, it is kind of implementation, which will be used for deployment.
There was a problem hiding this comment.
Yes this design document just outlines my changes to the default configurations. I will make another PR to add config files.
where is the sample data indices permission?
@Flyingliuhub I'm not sure what you mean by this. I've been able to add sample data from admin's side and see the visualizations/dashboard on the anonymous user's side without the anonymous user adding the data.
There was a problem hiding this comment.
after install sample data, it will create couple indices, do you have permission to see the data in the dashboards without add those ? maybe I'm wrong here
- 'opensearch_dashboards_sample_data_logs'
- 'opensearch_dashboards_sample_data_flights'
- 'opensearch_dashboards_sample_data_ecommerce'
There was a problem hiding this comment.
Could it be perhaps because I used "*" in my index patterns that I was able to access all 3 indices? Is the anonymous user allowed to read all of the indices?
There was a problem hiding this comment.
I would like to avoid * in the role, it is implement detail, nothing related with design, the design should highlight the change, you don't need to add detail here.
There was a problem hiding this comment.
Alright, I have removed some implementation details from the doc. Now it just displays a sample change and not the full change.
Signed-off-by: Huy Nguyen <[email protected]>
Signed-off-by: Huy Nguyen <[email protected]>
Signed-off-by: Huy Nguyen <[email protected]>
Signed-off-by: Huy Nguyen <[email protected]>
This reverts commit 365b666. Fixed signoff for commit Signed-off-by: Huy Nguyen <[email protected]>
huyaboo
changed the title
huyaboo
changed the title
seraphjiang
changed the title
huyaboo
dismissed
Flyingliuhub’s stale review
I changed the .md name to PLAYGROUND_DESIGN.
Signed-off-by: Huy Nguyen <[email protected]>
huyaboo
dismissed
seraphjiang’s stale review
PLAYGROUND_DESIGN.md is moved to /docs/playground
huyaboo
changed the title
…GROUNDS_DESIGN.md Signed-off-by: Huy Nguyen <[email protected]>
Signed-off-by: Huy Nguyen <[email protected]>
huyaboo
changed the title
Description
Added a revised design document for the OpenSearch Playgrounds Site (short term phase) based upon feedback given during the design review meeting.
Issues Resolved
Resolves #9
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.