-
Notifications
You must be signed in to change notification settings - Fork 45
docs: refresh permission key form and drop removed app.admin.users config #1901
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -50,11 +50,13 @@ app: | |
|
|
||
| # platform level administration | ||
| admin: | ||
| # email list of users which needs to be converted as superusers | ||
| # if the user is already present in the system, it is promoted to su | ||
| # if not, a new account is created with provided email id and promoted to su | ||
| users: | ||
| - test@example.com | ||
| # bootstrap seeds a superuser service account from config. Automation such as | ||
| # the GitOps reconcile flow logs in as it, so there is always a superuser | ||
| # without needing an existing one. Log in with: | ||
| # Authorization: Basic base64(client_id:client_secret). | ||
| bootstrap: | ||
| client_id: "" | ||
| client_secret: "" | ||
|
Comment on lines
+53
to
+59
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win Document the complete The bootstrap implementation disables the feature only when both fields are empty. Otherwise, it requires both fields and validates
📍 Affects 3 files
|
||
| # smtp configuration for sending emails | ||
| mailer: | ||
| smtp_host: sandbox.smtp.mailtrap.io | ||
|
|
@@ -85,7 +87,7 @@ to host frontier at somewhere like auth.example.com and main app at anywhere in | |
| - app.authentication.session.hash_secret_key: random 32 char key | ||
| - app.authentication.session.block_secret_key: random 32 char key | ||
| - app.cors_origin: url of the frontend to allow cross-origin request | ||
| - admin.users: list of emails we want to be promoted as instance admins | ||
| - admin.bootstrap: client_id and client_secret for the bootstrap superuser service account that automation logs in as | ||
| - app.mailer.*: all these details are used to send the email to user. Get test configurations from `mailtrap.io` for testing. | ||
| - db.url: local database instance credentials in following form | ||
| - `postgres://<username>:<password>@<hostname>:<hostport>/<database_name>?sslmode=disable` | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,7 +34,7 @@ List of supported environment variables | |
| Export the current state of a kind as a desired-state YAML file, printed to | ||
| stdout. The output is the format `frontier reconcile` reads: reconciling it | ||
| changes nothing. Supported kinds: `PlatformUser`, `Permission`, `Role`, | ||
| `Preference`, `Webhook`. See the | ||
| `Preference`, `Webhook`, `BillingProduct`, `BillingPlan`, and `MetaSchema`. See the | ||
| [Reconcile guide](../reconcile.md) for the file format and the flow. | ||
|
|
||
| ``` | ||
|
|
@@ -250,10 +250,14 @@ Make platform resources match a desired-state YAML file, through the admin | |
| API. Supported kinds: `PlatformUser` (anyone listed is added, anyone not | ||
| listed is removed), `Permission` (custom permissions), `Role` | ||
| (platform-level roles), `Preference` (platform settings, where a setting | ||
| left out of the file resets to its default), and `Webhook` (webhook endpoints). | ||
| left out of the file resets to its default), `Webhook` (webhook endpoints), | ||
| `BillingProduct` (billing products and their prices), `BillingPlan` (billing | ||
| plans and the products they bundle), and `MetaSchema` (metadata validation | ||
| schemas, where a schema left out resets to its shipped default). | ||
|
Comment on lines
+255
to
+256
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win Clarify which MetaSchema omission resets the schema. The phrase “a schema left out” suggests that omitting the Rewrite this as “a built-in 🧰 Tools🪛 LanguageTool[style] ~256-~256: To strengthen your wording, consider replacing the phrasal verb “leave out”. (OMIT_EXCLUDE) |
||
| Deleting a permission, a custom role, or a webhook needs an explicit | ||
| `delete: true` on its entry; nothing is deleted by omission, and a predefined | ||
| role cannot be deleted. Use | ||
| `delete: true` on its entry; nothing is deleted by omission, a predefined | ||
| role cannot be deleted, and a billing product or plan cannot be deleted | ||
| through the API. Use | ||
| `frontier export` to print the current state in this file format, and see the | ||
| [Reconcile guide](../reconcile.md) for the full flow. | ||
|
|
||
|
|
||
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.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Correct the documented scope of custom permissions.
This sentence limits custom permissions to Project resources.
docs/content/docs/authz/permission.mdxdocumentspotato.cart.*, andinternal/reconcile/permission_reconciler_test.goreconcilescompute.order.get. Replace the Project-specific wording with a scope-neutral statement.Proposed wording
📝 Committable suggestion