-
Notifications
You must be signed in to change notification settings - Fork 98
docs: implement multi-tenancy updates #3639
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
base: main
Are you sure you want to change the base?
Conversation
- Added integration>requirements>tenants - Updated existing pages
our good, forgotten friend
✅ Deploy Preview for brilliant-pasca-3e80ec ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
🚀 Performance Test ResultsTest Configuration:
Test Metrics:
📜 Logs
|
Hello @mkurapov , @BlairCurrey , @njlie , @oana-lolea , & @sanducb! I've completed a first pass on the multi-tenancy documentation updates. For this review, let's focus on technical accuracy only. Multi-tenancy touches a lot of areas, so a comprehensive check would be great to make sure I've captured everything correctly. Please disregard writing mechanics/style/tone for now; we'll address that in the next round of reviews. Thanks! |
packages/documentation/src/content/docs/resources/architecture.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/deployment/services/auth-service.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/playground/overview.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/requirements/exchange-rates.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/overview/concepts/multi-tenancy.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/overview/concepts/multi-tenancy.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/admin/admin-user-guide.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/admin/admin-user-guide.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/requirements/tenants.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/requirements/open-payments/idp.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/requirements/assets.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/requirements/peers.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/requirements/peers.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/requirements/peers.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/requirements/peers.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/requirements/wallet-addresses.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/overview/concepts/multi-tenancy.mdx
Show resolved
Hide resolved
packages/documentation/src/content/docs/overview/concepts/payment-pointers.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/admin/admin-user-guide.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/admin/admin-user-guide.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/admin/admin-user-guide.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/admin/admin-user-guide.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/requirements/assets.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/requirements/webhook-events.mdx
Outdated
Show resolved
Hide resolved
I wouldn't mind if this was addressed outside of this PR. But this got me thinking. Do we even need the local environment diagram? There are many ways to initialize it and I dont think we should try to depict all of it in one diagram. If we only want to depict 1 I'd assume it would be the default, which the diagram doesn't exactly depict as it currently is. 1 good Rafiki diagram and then the specific implementation details in the docker files makes sense to me. I realize I may be biased as someone whose often in the docker files, but then again, devs are going to be the primary audience for the readme. |
packages/documentation/src/content/docs/integration/deployment/services/backend-service.mdx
Outdated
Show resolved
Hide resolved
I would mention somewhere that the tenant's (non-operator) credentials (id, secret) need to be communicated to the tenant out-of-band. That is, the operator will have the uuid and secret after creating but the tenant wont. They need to securely communicate that. Rafiki doesnt do that. I would mention it at the end of the instructions for the operator to create the tenant and at the beginning of the instructions to set the credentials (operator will use the same as the env vars they set, tenant will use operator provided ones). Also, nice job on the updates! This was a big one. |
Priority items before merge:
|
Priority items: Operator must generate UUID v4 OPERATOR_TENANT_ID and API_SECRET, tenant's credentials need to be communicated to the tenant out of band, and request signing update
Hey @mkurapov - I think my latest commit passes the "priority items before merge" bar. Can you check some of the technical bits? Some of the high-level changes are as follows:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good, a few comments
packages/documentation/src/content/docs/admin/admin-user-guide.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/deployment/services/backend-service.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/requirements/overview.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/requirements/overview.mdx
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/requirements/webhook-events.mdx
Show resolved
Hide resolved
Minor edits
packages/documentation/src/content/docs/integration/requirements/overview.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/apis/graphql/admin-api-overview.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/deployment/services/backend-service.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/overview/concepts/multi-tenancy.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/requirements/tenants.mdx
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/requirements/tenants.mdx
Outdated
Show resolved
Hide resolved
packages/documentation/src/content/docs/integration/requirements/tenants.mdx
Outdated
Show resolved
Hide resolved
Minor fixes
With the addition of multi-tenancy support, the Rafiki docs need quite a bit of updating. I've tried to capture all of the changes where multi-tenancy has impacted Rafiki. FIxes #3545
New pages:
Updated content:
Still needs work/input:
There are some more areas that need some work that include, but are not limited to, the following:
Required
Conditional