documentation-website icon indicating copy to clipboard operation
documentation-website copied to clipboard

Added documentation for managed identity support in repository-azure plugin

Open chengwushi-netapp opened this issue 1 year ago • 3 comments

Description

Added documentation for managed identity support in repository-azure plugin

Issues Resolved

Closes https://github.com/opensearch-project/documentation-website/issues/6874

Checklist

  • [x] By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin. For more information on following Developer Certificate of Origin and signing off your commits, please check here.

chengwushi-netapp avatar May 01 '24 01:05 chengwushi-netapp

Hello @hdhalter, sorry for delaying this PR, i hope i am in time for the 30-april cut off.

In addition, i did not manage to find any dedicated section related to repository-azure plugin, so i end up adding a new section, below the Amazon S3 section in docs/latest/tuning-your-cluster/availability-and-recovery/snapshots/snapshot-restore/. Welcome suggestions if others view this differently. Cheers.

chengwushi-netapp avatar May 01 '24 02:05 chengwushi-netapp

No worries at all, @chengwushi-netapp! Thanks so much for creating this. I'll send it through the review process and we'll check on the location. In the meantime, can you please see if you can address any of the style check errors?

hdhalter avatar May 01 '24 03:05 hdhalter

@reta - Could you please check this PR from a technical standpoint?

hdhalter avatar May 01 '24 03:05 hdhalter

Thanks, @reta and @chengwushi-netapp! I'll send for doc review.

hdhalter avatar May 06 '24 15:05 hdhalter

@hdhalter I just noticed the version mismatch, it will be for 2.15.0 (not current release), sorry about that

reta avatar May 06 '24 15:05 reta

@hdhalter I just noticed the version mismatch, it will be for 2.15.0 (not current release), sorry about that

OK, no worries. I'll update.

hdhalter avatar May 06 '24 15:05 hdhalter

Hello @hdhalter, for your information, the PR for managed identity support, https://github.com/opensearch-project/OpenSearch/pull/12559, is merged and backported to 2.x. Just wondering if there is any more action items needed from my end to move this documentation PR forward?

chengwushi-netapp avatar May 20 '24 01:05 chengwushi-netapp

Hello @hdhalter, for your information, the PR for managed identity support, opensearch-project/OpenSearch#12559, is merged and backported to 2.x. Just wondering if there is any more action items needed from my end to move this documentation PR forward?

Will the feature be released in 2.15 or has it been merged independently? Let me send it through a doc and editorial review. Just keep an eye out for questions from the tech writer and editor. Thanks.

hdhalter avatar May 20 '24 15:05 hdhalter

Need more insight on line 343

@Naarcha-AWS , as mentioned above, i have added some descriptions about the configuration when using token credential. Also, i have make a slight changes to the layout, i hope that would be clearer to the user reading it.

feel free to make any changes if needed and do remember to pull the latest branch before editing, because I did a rebase of the branch. Cheers. Chengwu

chengwushi-netapp avatar May 23 '24 06:05 chengwushi-netapp

Need more insight on line 343

@Naarcha-AWS , as mentioned above, i have added some descriptions about the configuration when using token credential. Also, i have make a slight changes to the layout, i hope that would be clearer to the user reading it.

feel free to make any changes if needed and do remember to pull the latest branch before editing, because I did a rebase of the branch. Cheers. Chengwu

Thanks! Taking a look now.

Naarcha-AWS avatar May 23 '24 18:05 Naarcha-AWS

Hello @Naarcha-AWS @andrross @scrawfor99 @hdhalter, just wondering if there is anymore feedback in this PR which i could address? Cheers, Chengwu

chengwushi-netapp avatar May 29 '24 23:05 chengwushi-netapp

@chengwushi-netapp: Our reviews are complete. Let me know if this is ready to merge in advance of the 2.15 release.

Naarcha-AWS avatar Jun 12 '24 20:06 Naarcha-AWS

@chengwushi-netapp: Our reviews are complete. Let me know if this is ready to merge in advance of the 2.15 release.

Thank you @Naarcha-AWS and @natebower for the reviews. Yes, I believe this is ready to be merged, given that the implementation PR for managed identity support has already merged and backported to 2.15.0.

@hdhalter Do correct me if am wrong about this.

chengwushi-netapp avatar Jun 12 '24 23:06 chengwushi-netapp