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

Doc: Created a separate topic for AWS authentication #39012

Merged

Conversation

achatterjee-grafana
Copy link
Contributor

As part of the conversation in this discussion: #38112

Since the RedShift and Athena docs still live in their own repo, we needed an HTTP URL and could not do single sourcing in the truest sense yet. We will tackle that later.

Checked and fixed broken relrefs.

@achatterjee-grafana achatterjee-grafana requested review from osg-grafana, Eve832 and sunker and removed request for a team September 8, 2021 22:37
@achatterjee-grafana achatterjee-grafana added the old backport v8.1.x Mark PR for automatic backport to v8.1.x label Sep 8, 2021
docs/sources/datasources/aws-cloudwatch/_index.md Outdated Show resolved Hide resolved
docs/sources/datasources/aws-cloudwatch/_index.md Outdated Show resolved Hide resolved
docs/sources/datasources/aws-cloudwatch/_index.md Outdated Show resolved Hide resolved
docs/sources/datasources/aws-cloudwatch/_index.md Outdated Show resolved Hide resolved
docs/sources/datasources/aws-cloudwatch/_index.md Outdated Show resolved Hide resolved
docs/sources/datasources/aws-cloudwatch/_index.md Outdated Show resolved Hide resolved
docs/sources/datasources/aws-cloudwatch/_index.md Outdated Show resolved Hide resolved
docs/sources/datasources/aws-cloudwatch/_index.md Outdated Show resolved Hide resolved
docs/sources/datasources/aws-cloudwatch/_index.md Outdated Show resolved Hide resolved
Copy link
Contributor

@GrafanaWriter GrafanaWriter left a comment

Choose a reason for hiding this comment

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

Thank you for making this update. Minor edits to smooth and clarify.

docs/sources/datasources/aws-cloudwatch/_index.md Outdated Show resolved Hide resolved
docs/sources/datasources/aws-cloudwatch/_index.md Outdated Show resolved Hide resolved
docs/sources/datasources/aws-cloudwatch/_index.md Outdated Show resolved Hide resolved
Copy link
Contributor

@sunker sunker left a comment

Choose a reason for hiding this comment

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

Looks great! A few comments from me:

docs/sources/datasources/aws-cloudwatch/aws-authentication.md . Does this have to live under the aws-cloudwatch directory? Maybe it can be docs/sources/datasources/aws/aws-authentication.md?

When it comes to auth options, there's actually four options. The first three, AWS SDK Default, Credentials file and Access & secret key are enabled by default in open source grafana. The fourth, and currently undocumented option, is called Workspace IAM role role. This new option (and Access & secret key) are enabled by default in AMG. I can take a stab at writing a draft for the new, undocumented auth option.

Anyone who can access the server configuration of Grafana can enable/disable this authentication options. This is documented here, but I think it would be great if we describe that shortly in this document and link to the configuration.

Currently, everything in the aws-authentication.md file is generic information that applies to any AWS data source except for the part about IAM policies, so this section needs to be described in each separate data source documentation.

@achatterjee-grafana achatterjee-grafana merged commit d3a7e02 into main Sep 13, 2021
@achatterjee-grafana achatterjee-grafana deleted the Doc-Move-AWS-authetication-to-separate-topic branch September 13, 2021 23:30
grafanabot pushed a commit that referenced this pull request Sep 13, 2021
* Created new topic for AWS authentication and fixed broken relrefs.

* Applied suggestion from review.

* Update docs/sources/datasources/aws-cloudwatch/aws-authentication.md

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>

* Applied some suggestions from doc review.

* Applied all doc review.

* Last of the edits, went through and addressed all comments.

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>
(cherry picked from commit d3a7e02)
achatterjee-grafana added a commit that referenced this pull request Sep 14, 2021
* Created new topic for AWS authentication and fixed broken relrefs.

* Applied suggestion from review.

* Update docs/sources/datasources/aws-cloudwatch/aws-authentication.md

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>

* Applied some suggestions from doc review.

* Applied all doc review.

* Last of the edits, went through and addressed all comments.

Co-authored-by: Fiona Artiaga <89225282+GrafanaWriter@users.noreply.github.com>
(cherry picked from commit d3a7e02)

Co-authored-by: achatterjee-grafana <70489351+achatterjee-grafana@users.noreply.github.com>
stevepostill pushed a commit to Reveal-International/grafana that referenced this pull request Nov 3, 2021
…-github to revdev

* commit '56aebaac32bd7a82f84a571969b51c62ba54fd6d': (23 commits)
  "Release: Updated versions in package to 8.1.4" (grafana#39273)
  Docs: Update azuread docs to mention about env variables (grafana#39203) (grafana#39265)
  Docs: plugin migration guide 7.0.0 to 8.0.0 (grafana#38911) (grafana#39246)
  Docs: Added "manageAlerts" provisioning option. (grafana#38836) (grafana#39253)
  BarChart: Fix legend and tooltip colors off by 1 after data refresh (grafana#39234) (grafana#39252)
  Update silences.md (grafana#38834) (grafana#39243)
  Explore: Ensure logs volume bar colors match legend colors (grafana#39072) (grafana#39120)
  Graph: make old graph panel thresholds work even if ngalert is enabled  (grafana#38918) (grafana#39233)
  Fix regex to identify / as separator (grafana#39220)
  [v8.1.x] BarChart: fix stale bar values and x axis labels
  Add link to default template (grafana#39106) (grafana#39138)
  Doc: Created a separate topic for AWS authentication  (grafana#39012) (grafana#39160)
  LDAP: Search all DNs for users (grafana#38891) (grafana#39167)
  Docs: Fix broken link to signed GCS URLs docs (grafana#39144) (grafana#39149)
  [v8.1.x] Variables: Fix not updating inside a Panel when the preceding Row uses "Repeat For" (grafana#39141)
  Docs: Improve v8 upgrade notes for SQL data sources (grafana#38792) (grafana#39124)
  Explore: Trace view now shows trace start time in selected timezone (grafana#39054) (grafana#39093)
  Alerting: Fix notification channel migration (grafana#38983) (grafana#39053)
  Annotations: Fixes blank panels for queries with unknown data sources (grafana#39017) (grafana#39034)
  Copy cue.mod and packages/grafana-schema to container workdir (grafana#38998) (grafana#39018)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
old backport v8.1.x Mark PR for automatic backport to v8.1.x type/docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants