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

Docs: add access policies for OpenSearch Service and OpenSearch Serverless #97

Merged
merged 2 commits into from
Feb 6, 2023

Conversation

kevinwcyu
Copy link
Contributor

This PR documents the minimal set of permissions required to use the opensearch datasource with OpenSearch Service and OpenSearch Serverless.

Fixes: #96

Changes:

  • Updated references of Elasticsearch Service to OpenSearch Service
  • Add different informational sections on access policies for OpenSearch Service and OpenSearch Serverless

Notes to reviewer:
I tested these permissions the default query for the datasource. I don't know if there are other permissions required depending on the query or some other settings.

References:

@kevinwcyu kevinwcyu requested a review from a team as a code owner January 30, 2023 19:03
Copy link
Member

@sarahzinger sarahzinger left a comment

Choose a reason for hiding this comment

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

This looks good to me! Should we make a comment you think to say Open Search Serverless should be supported in Grafana 9.4 and above? cc @svennergr @gabor

@gabor
Copy link
Contributor

gabor commented Jan 31, 2023

@sarahzinger wrote:

Should we make a comment you think to say Open Search Serverless should be supported in Grafana 9.4 and above?

good idea!

hmm.. though..the question is, what should we say in the required-grafana-version setting in plugin.json : https://github.com/grafana/opensearch-datasource/blob/main/src/plugin.json#L30 ?

possibilities:

  • set it to grafana9.4.0... if we do that, maybe we don't need to mention this in the README
  • keep it as it is, and just accept that on older grafanas opensearch-serverless is just not going to work.

what do you think?

@kevinwcyu
Copy link
Contributor Author

kevinwcyu commented Jan 31, 2023

@sarahzinger wrote:

Should we make a comment you think to say Open Search Serverless should be supported in Grafana 9.4 and above?

good idea!

hmm.. though..the question is, what should we say in the required-grafana-version setting in plugin.json : https://github.com/grafana/opensearch-datasource/blob/main/src/plugin.json#L30 ?

possibilities:

  • set it to grafana9.4.0... if we do that, maybe we don't need to mention this in the README
  • keep it as it is, and just accept that on older grafanas opensearch-serverless is just not going to work.

what do you think?

I'm leaning towards keeping the required grafana version as-is because the opensearch-service part should still work for older versions and people who actively want to use opensearch-serverless will have to make the decision to upgrade grafana or not. Also looks like opensearch serverless was only recently released, so probably not many people using it just yet. So it seems like it would be lower friction for existing opensearch-service users if we leave the required version as-is for the moment.

@kevinwcyu
Copy link
Contributor Author

@gabor I'm trying to tag the docs squad to review this, but they don't show up in reviewers dropdown for me. I think they need to be added as collaborators on this repo to show up in the reviewers dropdown. Would you be able to add them please?

@svennergr svennergr requested review from a team, JStickler and knylander-grafana and removed request for a team January 31, 2023 17:57
@svennergr
Copy link
Contributor

@gabor I'm trying to tag the docs squad to review this, but they don't show up in reviewers dropdown for me. I think they need to be added as collaborators on this repo to show up in the reviewers dropdown. Would you be able to add them please?

Done

Copy link

@JStickler JStickler left a comment

Choose a reason for hiding this comment

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

[Docs squad] LGTM

@kevinwcyu kevinwcyu merged commit acc4ce1 into main Feb 6, 2023
@kevinwcyu kevinwcyu deleted the kevinwcyu/add-policies branch February 6, 2023 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document IAM Policy Permissions
5 participants