docs(nx-cloud): update release notes #32054
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
View your CI Pipeline Execution ↗ for commit d56ff3d
☁️ Nx Cloud last updated this comment at |
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
| - name: VALKEY_PASSWORD | ||
| value: 'valkey' | ||
| - name: VALKEY_PASSWORD | ||
| valueFrom: | ||
| # remember to apply this secret to your cluster | ||
| secretKeyRef: | ||
| name: valkey-secrets | ||
| key: VALKEY_PASSWORD |
There was a problem hiding this comment.
The VALKEY_PASSWORD environment variable is defined twice in this configuration:
- name: VALKEY_PASSWORD
value: 'valkey'
- name: VALKEY_PASSWORD
valueFrom:
secretKeyRef:
name: valkey-secrets
key: VALKEY_PASSWORDThis creates a conflict where Kubernetes will use only one definition. The hardcoded value should be removed in favor of the secret reference, as storing passwords in plain text within configuration files poses a security risk. The secret-based approach follows security best practices for credential management.
| - name: VALKEY_PASSWORD | |
| value: 'valkey' | |
| - name: VALKEY_PASSWORD | |
| valueFrom: | |
| # remember to apply this secret to your cluster | |
| secretKeyRef: | |
| name: valkey-secrets | |
| key: VALKEY_PASSWORD | |
| - name: VALKEY_PASSWORD | |
| valueFrom: | |
| # remember to apply this secret to your cluster | |
| secretKeyRef: | |
| name: valkey-secrets | |
| key: VALKEY_PASSWORD |
Spotted by Diamond
Is this helpful? React 👍 or 👎 to let us know.
|
|
||
| This upgrades includes a breaking change to the `nx-cloud` cluster: instead of a messagequeue, the `nx-api` pod need a valid Valkey (Redis) connection string. | ||
|
|
||
| 1. Install valkey: 2. You can either use the Bitnami chart: https://github.com/bitnami/charts/tree/main/bitnami/valkey 2. Or for a simpler deployment, you can use the Valkey docker image directly: https://hub.docker.com/r/valkey/valkey/ 3. Or you can install it as a system service: https://valkey.io/topics/installation/ |
There was a problem hiding this comment.
The numbering format in this instruction is inconsistent and difficult to follow. Consider restructuring this section with proper hierarchical numbering:
1. Install Valkey using one of these options:
a. Use the Bitnami chart: https://github.com/bitnami/charts/tree/main/bitnami/valkey
b. For a simpler deployment, use the Valkey docker image directly: https://hub.docker.com/r/valkey/valkey/
c. Install it as a system service: https://valkey.io/topics/installation/
This would make the installation steps clearer for users following these instructions.
| 1. Install valkey: 2. You can either use the Bitnami chart: https://github.com/bitnami/charts/tree/main/bitnami/valkey 2. Or for a simpler deployment, you can use the Valkey docker image directly: https://hub.docker.com/r/valkey/valkey/ 3. Or you can install it as a system service: https://valkey.io/topics/installation/ | |
| 1. Install Valkey using one of these options: | |
| a. Use the Bitnami chart: https://github.com/bitnami/charts/tree/main/bitnami/valkey | |
| b. For a simpler deployment, use the Valkey docker image directly: https://hub.docker.com/r/valkey/valkey/ | |
| c. Install it as a system service: https://valkey.io/topics/installation/ | |
Spotted by Diamond
Is this helpful? React 👍 or 👎 to let us know.
|
|
||
| ##### Breaking Change | ||
|
|
||
| This upgrades includes a breaking change to the `nx-cloud` cluster: instead of a messagequeue, the `nx-api` pod need a valid Valkey (Redis) connection string. |
There was a problem hiding this comment.
There's a grammatical error in the first sentence. It should be either "This upgrade includes" (singular) or "These upgrades include" (plural) rather than "This upgrades includes".
| This upgrades includes a breaking change to the `nx-cloud` cluster: instead of a messagequeue, the `nx-api` pod need a valid Valkey (Redis) connection string. | |
| This upgrade includes a breaking change to the `nx-cloud` cluster: instead of a messagequeue, the `nx-api` pod need a valid Valkey (Redis) connection string. |
Spotted by Diamond
Is this helpful? React 👍 or 👎 to let us know.
| - name: NX_CLOUD_CONFORMANCE_RULES_BUCKET | ||
| value: local-cluster-file-server # use this exact value if you are using the file server, otherwise point it to an S3/Azure/Google bucket |
There was a problem hiding this comment.
is it worth calling out if using a bucket storage to just use the same values as the cache bucket ? IIRC the conformance rules are in a sub folder anyway so should be fine (idk if that's us doing the subfoldering or the conn string to the bucket says to use the subfolder)
There was a problem hiding this comment.
that's a good point - I actually wasn't sure if people can re-use the same bucket they use for the cache, and if it would be under a sub-folder like you said
let me double-check with Louie and I'll add it in
Co-authored-by: Caleb Ukle <caleb.ukle+github@pm.me>
<!-- Please make sure you have read the submission guidelines before posting an PR --> <!-- https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr --> <!-- Please make sure that your commit message follows our format --> <!-- Example: `fix(nx): must begin with lowercase` --> <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior <!-- This is the behavior we have today --> ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes # --------- Co-authored-by: Caleb Ukle <caleb.ukle+github@pm.me>
Current Behavior
Expected Behavior
Related Issue(s)
Fixes #