Repository navigation
docs: GitOps and own-Secrets examples for 2.0.0's defaults - #26
Conversation
With Functions and Sites and the built-in object storage on by default, the
generate: false examples in gitops.md and security.md no longer rendered
("No value for executor-secret", then the S3 keys): with generation off, the
built-in store's keys and the compute secrets have to come from Secrets too.
Both examples now include them (and the Argo CD Application keeps one storage
block); the credentials table says when they're needed by default, and how to
leave Functions and Sites out instead.
Also names storage.s3.external.endpoint and .region where storage.md's
provider table and troubleshooting's S3 entry still said endpoint and region,
and adds the built-in store to that entry.
🔵 Tier A · Mergeable after minor fixes
Updates the GitOps and own-Secrets examples for the chart’s default compute and built-in S3 configuration, and corrects the external S3 value paths and troubleshooting guidance. It also documents the Sysbox configuration for running the executor without a privileged container. Latest changes: The latest commits clarify that Sysbox requires
Fix with agent prompt### Issue 1
docs/gitops.md:40-49
**The documented Secret creation command omits these required keys**
The `kubectl create secret` example below creates `appwrite-credentials` without `s3-access-key`, `s3-secret-key`, `executor-secret` or `orchestrator-secret`, but this values example now points S3 and compute credentials at that Secret. Following the documented setup therefore leaves required keys absent; please add them to the creation instructions or mark that command as partial.
### Issue 2
docs/gitops.md:56-57
**The no-compute instructions contradict each other**
This says to set `compute.enabled: false` and leave out the entire `compute` block, but the setting itself must be in that block (and compute is enabled by default). A user omitting the block will still render Functions and Sites; clarify that they need a minimal `compute: { enabled: false }` setting.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.📂 Walkthrough · 7
⏳ Still open from earlier reviews · 2
Reviewed the commits since |
| > s3: # the built-in object storage's keys too | ||
| > accessKeyId: | ||
| > secretName: appwrite-credentials | ||
| > secretAccessKey: | ||
| > secretName: appwrite-credentials | ||
| > compute: | ||
| > secrets: | ||
| > existingSecret: appwrite-credentials | ||
| > executor: | ||
| > existingSecret: appwrite-executor # a copy in the executor namespace |
There was a problem hiding this comment.
The documented Secret creation command omits these required keys
The kubectl create secret example below creates appwrite-credentials without s3-access-key, s3-secret-key, executor-secret or orchestrator-secret, but this values example now points S3 and compute credentials at that Secret. Following the documented setup therefore leaves required keys absent; please add them to the creation instructions or mark that command as partial.
Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/gitops.md
Line: 40-49
Comment:
**The documented Secret creation command omits these required keys**
The `kubectl create secret` example below creates `appwrite-credentials` without `s3-access-key`, `s3-secret-key`, `executor-secret` or `orchestrator-secret`, but this values example now points S3 and compute credentials at that Secret. Following the documented setup therefore leaves required keys absent; please add them to the creation instructions or mark that command as partial.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.🟡 Minor · documentation · Reply if this doesn't apply.
| > its namespace. Without Functions and Sites, set `compute.enabled: false` | ||
| > and leave out the `compute` block. [Credentials](#credentials) has the |
There was a problem hiding this comment.
The no-compute instructions contradict each other
This says to set compute.enabled: false and leave out the entire compute block, but the setting itself must be in that block (and compute is enabled by default). A user omitting the block will still render Functions and Sites; clarify that they need a minimal compute: { enabled: false } setting.
Prompt To Fix With AI
This is a comment left during a code review.
Path: docs/gitops.md
Line: 56-57
Comment:
**The no-compute instructions contradict each other**
This says to set `compute.enabled: false` and leave out the entire `compute` block, but the setting itself must be in that block (and compute is enabled by default). A user omitting the block will still render Functions and Sites; clarify that they need a minimal `compute: { enabled: false }` setting.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.🟡 Minor · documentation · Reply if this doesn't apply.
compute.executor.privileged defaults to true since 2.0.0, so setting only runtimeClassName still renders a privileged container. security.md, the troubleshooting FAQ and the values comments now say to set privileged: false with the Sysbox runtime class, as executor.md already did.
What
Checking the docs against 2.0.0's S3 changes found one real breakage and some imprecise naming.
The
generate: falseexamples no longer rendered. Both the GitOps example (docs/gitops.md, the warning block and the Argo CD Application) and the own-Secrets example (docs/security.md) failed withNo value for executor-secret: provide it explicitly or through an existing Secret (appwrite.secrets.generate is false). The built-in object storage's keys would have failed next. Since 2.0.0, Functions and Sites and the built-in store are on by default, and with generation off their credentials have to come from Secrets too.storage.s3.accessKeyIdandsecretAccessKey, which the built-in store needs as well, pluscompute.secrets.existingSecretandcompute.executor.existingSecret.compute.enabled: false, nocomputeblock).storageblock.S3 key names:
storage.md's provider table and AWS note saystorage.s3.external.endpointandexternal.region, not bareendpointandregion.Everything else checked out: no
storage.s3.endpointor.regionis left at the old level. Everyendpoint:in the docs, examples and CI values sits underexternal:, except the deliberate "Before" snippet in the upgrade notes.Sysbox needs
privileged: false.compute.executor.privilegeddefaults totruesince 2.0.0, so setting onlyruntimeClassName: sysbox-runcstill renders a privileged container (checked withhelm template).security.md, the troubleshooting FAQ and thevalues.yamlcomments now say to setprivileged: falsewith the runtime class, asexecutor.mdalready did. hansi-codes found this on the announcement PR (appwrite/appwrite#14402).skip-changelog: docs and values comments only.Testing
valuesObject, and thesecurity.mdexample. All four render now; the first, third and fourth failed before.make testpasses.