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.

Sign up for GitHub

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

Jump to bottom

HDDS-6275. [Multi-Tenant] Add feature documentation and CLI quick start guide #3095

Merged
merged 16 commits into from
Mar 7, 2022
Merged

HDDS-6275. [Multi-Tenant] Add feature documentation and CLI quick start guide #3095

merged 16 commits into from
Mar 7, 2022

Conversation

smengcl
Copy link
Contributor

@smengcl smengcl commented Feb 16, 2022 •
edited
Loading

What changes were proposed in this pull request?

  • Add feature documentation Multi-Tenancy.md
  • Add CLI quick start guide Tenant.md
  • Cosmetic change to ozone tenant revokeadmin CLI output
  • Append mock server initialization JSON to mock Ranger response for ozone tenant assignadmin

What is the link to the Apache JIRA

https://issues.apache.org/jira/browse/HDDS-6275

How was this patch tested?

  • All existing tests should pass.
  • Preview the doc with hugo serve:
cd hadoop-hdds/docs
huge serve &
open http://127.0.0.1:1313

@smengcl
HDDS-6275. [Multi-Tenant] Add feature documentation and CLI quick sta…
b882d68 
…rt guide

(cherry picked from commit 34723000dff7fe1c383e2fa8272134a4f8e2a760)
@smengcl
Reorganize quick start guide intro paragraph.
7ddcbda 
Change-Id: I6460ac86425a207d3e714da6883d01ec927a9883
@smengcl
Merge remote-tracking branch 'asf/HDDS-4944' into HDDS-6275
6d82598 
Change-Id: Ib0ffaa9e912a296a396740bd5bf643e3af9ee008
@smengcl
Add dot.
da62c08 
Change-Id: Id7addf7af980c2d9155acfbdeeb50ba83961acb6
@smengcl
Add new sub page multi-tenancy setup; address comments.
dd37906 
Change-Id: Ice6e6b7bd9cb0ff1d5c106993db428cef8b4a12f
@smengcl
Retrigger
65005df 
Change-Id: I40b85261870f5252eb9a4e2fd7fe35f2df5ebea1
errose28
errose28 reviewed Feb 23, 2022
View reviewed changes
Copy link
Contributor

@errose28 errose28 left a comment

Choose a reason for hiding this comment

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

Thanks for writing this up @smengcl. I think we should add a section on Ranger integration to explain what items in Ranger are created when a tenant is created, and that add and remove operations for users or admins will not have immediate effect because the ranger plugin has to sync.

hadoop-hdds/docs/content/feature/Multi-Tenancy.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/feature/Multi-Tenancy.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/feature/Multi-Tenancy.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/feature/Multi-Tenancy-Setup.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/interface/Tenant.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/interface/Tenant.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/interface/Tenant.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/interface/Tenant.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/interface/Tenant.md Outdated Show resolved Hide resolved
@smengcl
Copy link
Contributor Author

smengcl commented Feb 24, 2022

Thanks for reviewing this @errose28 .

I think we should add a section on Ranger integration to explain what items in Ranger are created when a tenant is created, and that add and remove operations for users or admins will not have immediate effect because the ranger plugin has to sync.

I have described which policies are added in Ranger when a tenant is created, under the section "Access Control". I guess I need to mention those admin/user roles created as well. Thanks for the reminder.

@smengcl
Multi-Tenancy -> S3 Multi-Tenancy
42c793e 
Change-Id: I41844ea01c48a281c5d72e378f9f49e127dd29a0
@smengcl
Add Ranger role explanation
af8cbf8 
Change-Id: Ib041f6f0fe136dc120936d41eea0c8b467b4849d
@smengcl
Clarify user, accessId and tenant relationship
83116ad 
Change-Id: I6f323c3a05f4d6209eea5c9402458e75302fd3e9
@smengcl
Address the rest of the comments
c87013a 
Change-Id: I34a25611b6745ffb48f9087916c4b025940abdee
@smengcl
Improve AssignAdminHandler help message
25ad64f 
Change-Id: I2b2214d62dae303c10b6ed68fd14308fc10c8680
@smengcl
Explain <USER_NAME>
e5cf15b 
Change-Id: Idf0e4f8093638250fe48c9db46b23b8bdde7f959
@smengcl
Remove unused shortcode
d7e1b63 
Change-Id: I0480567049dd2a1a0da009a11b2f0156b09ae43a
@smengcl
Copy link
Contributor Author

smengcl commented Feb 24, 2022 •
edited
Loading

@errose28 This is ready for another look.

errose28
errose28 reviewed Feb 28, 2022
View reviewed changes
Copy link
Contributor

@errose28 errose28 left a comment

Choose a reason for hiding this comment

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

Thanks for the updates @smengcl I left some more comments.

hadoop-hdds/docs/content/feature/S3-Multi-Tenancy-Setup.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/feature/S3-Multi-Tenancy-Setup.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/feature/S3-Multi-Tenancy.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/feature/S3-Multi-Tenancy.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/feature/S3-Multi-Tenancy.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/interface/S3-Tenant.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/interface/S3-Tenant.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/interface/S3-Tenant.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/feature/S3-Multi-Tenancy.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/feature/S3-Multi-Tenancy.md Show resolved Hide resolved
@smengcl
Address comments
eb78f0d 
Change-Id: I9725018dcfe0f64c9f5275d8b726cda484af09bc
@smengcl
Fix class comment
e4c61d8 
Change-Id: I1cd93c6777e77cbe147384172b4bc527a7617dc5
errose28
errose28 reviewed Mar 4, 2022
View reviewed changes
Copy link
Contributor

@errose28 errose28 left a comment

Choose a reason for hiding this comment

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

Thanks for the continued updates @smengcl. Looks pretty good overall. I left a few minor comments on the new section. I noticed the subsections for multi-tenancy are behaving a bit weird on the site:

  • On http://localhost:1313/feature.html each subsection is displayed twice, when Ideally just the top level multi-tenancy section would be displayed here.
  • The Next button at the bottom of each subsection does not take you to the next subsection.

I'm not sure exactly how to fix it, but it looks like some hugo tweaks are needed.

hadoop-hdds/docs/content/feature/S3-Multi-Tenancy-Access-Control.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/feature/S3-Multi-Tenancy-Access-Control.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/feature/S3-Multi-Tenancy-Access-Control.md Outdated Show resolved Hide resolved
hadoop-hdds/docs/content/feature/S3-Multi-Tenancy-Access-Control.md Outdated Show resolved Hide resolved
@smengcl
Address comments
d5a3c08 
Change-Id: I390c4a1c06b05dea7d25ff16de89b26473467b49
errose28
errose28 approved these changes Mar 7, 2022
View reviewed changes
Copy link
Contributor

@errose28 errose28 left a comment

Choose a reason for hiding this comment

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

Thanks for fixing the hugo layout @smengcl. The new pages LGTM.

@smengcl
Copy link
Contributor Author

smengcl commented Mar 7, 2022

Thanks @errose28 for the thorough review!

CI passed on my fork's branch here. Note this PR includes some cosmetic changes to the CLI handler.

@smengcl smengcl merged commit ecb685a into apache:HDDS-4944 Mar 7, 2022
errose28 added a commit to errose28/ozone that referenced this pull request Mar 30, 2022
@errose28
Merge branch 'HDDS-4944' into HDDS-5836
9bf4814 
* HDDS-4944: (268 commits)
  HDDS-6366. [Multi-Tenant] Disallow specifying custom accessId in OzoneManager (apache#3166)
  HDDS-6275. [Multi-Tenant] Add feature documentation and CLI quick start guide (apache#3095)
  HDDS-6063. [Multi-Tenant] Use VOLUME_LOCK in read and write requests, and some minor refactoring (apache#3051)
  HDDS-6214. [Multi-Tenant] Fix KMS Encryption/Decryption (apache#3010)
  HDDS-6322. Fix Recon getting inccorrect sequenceNumber from OM (apache#3090)
  HDDS-5913. Avoid integer overflow when setting dfs.container.ratis.lo… (apache#2785)
  HDDS-6313. Remove replicas in ContainerStateMap when a container is deleted (apache#3086)
  HDDS-6186. Selective checks: skip integration check for unit test changes (apache#3061)
  HDDS-6310. Update json-smart to 2.4.7. (apache#3080)
  HDDS-6190. Cleanup unnecessary datanode id path checks. (apache#2993)
  HDDS-6304. Add enforcer to make sure ozone.version equals project.version (apache#3075)
  HDDS-6309. Update ozone-runner version to 20220212-1 (apache#3079)
  HDDS-6293. Allow using custom ozone-runner image (apache#3072)
  HDDS-4126. Freon key generator should support >2GB files. (apache#3054)
  HDDS-6088. Implement O3FS/OFS getFileChecksum() using file checksum helpers - addendum: fix checkstyle
  HDDS-6088. Implement O3FS/OFS getFileChecksum() using file checksum helpers. (apache#2935)
  HDDS-6084. [Multi-Tenant] Handle upgrades to version supporting S3 multi-tenancy (apache#3018)
  HDDS-6257. Wrong stack trace for S3 errors (apache#3066)
  HDDS-6278 Improve memory profile for listStatus API call. (apache#3053)
  HDDS-6285. ozonesecure-mr intermittently failing with timeout downloading packages (apache#3057)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@errose28 errose28 errose28 approved these changes

@prashantpogde prashantpogde Awaiting requested review from prashantpogde

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@smengcl @errose28