docs(core): add local cache information for powerpack (#29630)
<!-- 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 --> Also includes update ENV variables ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #
This commit is contained in:
Jonathan Cammisuli
GitHub
parent
c32d2c77f4
commit
cad265dad6
@ -189,17 +189,7 @@
|
||||
}
|
||||
],
|
||||
"executors": [],
|
||||
"generators": [
|
||||
{
|
||||
"description": "Initialize the S3 Cache",
|
||||
"file": "external-generated/packages/powerpack-s3-cache/generators/init.json",
|
||||
"hidden": false,
|
||||
"name": "init",
|
||||
"originalFilePath": "/libs/nx-packages/powerpack-s3-cache/src/generators/init/schema.json",
|
||||
"path": "powerpack-s3-cache/generators/init",
|
||||
"type": "generator"
|
||||
}
|
||||
],
|
||||
"generators": [],
|
||||
"githubRoot": "https://github.com/nrwl/nx/blob/master",
|
||||
"name": "powerpack-s3-cache",
|
||||
"packageName": "@nx/powerpack-s3-cache",
|
||||
|
||||
@ -81,3 +81,29 @@ Finally, you need to configure your Nx cache in the `nx.json` file. The `contain
|
||||
| --------------- | -------------------------------- |
|
||||
| **container** | The name of the container to use |
|
||||
| **accountName** | The name of blob storage account |
|
||||
|
||||
# Cache Modes
|
||||
|
||||
By default, Nx will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
|
||||
|
||||
Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read-only` or `no-cache` in the `nx.json` file.
|
||||
|
||||
```jsonc {% fileName="nx.json" %}
|
||||
{
|
||||
"azure": {
|
||||
// ...
|
||||
"localMode": "read-only"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The cache mode in CI can also be configured by setting `ciMode` to `read-only` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read-only` or `no-cache` in the CI environment.
|
||||
|
||||
```jsonc {% fileName="nx.json" %}
|
||||
{
|
||||
"azure": {
|
||||
// ...
|
||||
"ciMode": "read-only"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@ -80,3 +80,29 @@ Finally, you need to configure your Nx cache in the `nx.json` file. The `bucket`
|
||||
| **Property** | **Description** |
|
||||
| ------------ | ----------------------------- |
|
||||
| **bucket** | The name of the bucket to use |
|
||||
|
||||
# Cache Modes
|
||||
|
||||
By default, Nx will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
|
||||
|
||||
Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read-only` or `no-cache` in the `nx.json` file.
|
||||
|
||||
```jsonc {% fileName="nx.json" %}
|
||||
{
|
||||
"gcs": {
|
||||
// ...
|
||||
"localMode": "read-only"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The cache mode in CI can also be configured by setting `ciMode` to `read-only` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read-only` or `no-cache` in the CI environment.
|
||||
|
||||
```jsonc {% fileName="nx.json" %}
|
||||
{
|
||||
"gcs": {
|
||||
// ...
|
||||
"ciMode": "read-only"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@ -152,3 +152,31 @@ Below is an example on how to connect to MinIO:
|
||||
| **endpoint** | The custom endpoint to upload artifacts to. If endpoint is not defined, the default AWS endpoint is used |
|
||||
| **accessKeyId** | AWS Access Key ID (optional if `AWS_ACCESS_KEY_ID` is set in the environment) |
|
||||
| **secretAccessKey** | AWS secret access key (optional if `AWS_SECRET_ACCESS_KEY` is set in the environment) |
|
||||
|
||||
# Cache Modes
|
||||
|
||||
By default, Nx will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
|
||||
|
||||
Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read-only` or `no-cache` in the `nx.json` file.
|
||||
|
||||
```jsonc {% fileName="nx.json" %}
|
||||
{
|
||||
"s3": {
|
||||
"region": "us-east-1",
|
||||
"bucket": "my-bucket",
|
||||
"localMode": "read-only"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The cache mode in CI can also be configured by setting `ciMode` to `read-only` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read-only` or `no-cache` in the CI environment.
|
||||
|
||||
```jsonc {% fileName="nx.json" %}
|
||||
{
|
||||
"s3": {
|
||||
"region": "us-east-1",
|
||||
"bucket": "my-bucket",
|
||||
"ciMode": "read-only"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@ -10980,23 +10980,6 @@
|
||||
],
|
||||
"isExternal": false,
|
||||
"disableCollapsible": false
|
||||
},
|
||||
{
|
||||
"id": "generators",
|
||||
"path": "/nx-api/powerpack-s3-cache/generators",
|
||||
"name": "generators",
|
||||
"children": [
|
||||
{
|
||||
"id": "init",
|
||||
"path": "/nx-api/powerpack-s3-cache/generators/init",
|
||||
"name": "init",
|
||||
"children": [],
|
||||
"isExternal": false,
|
||||
"disableCollapsible": false
|
||||
}
|
||||
],
|
||||
"isExternal": false,
|
||||
"disableCollapsible": false
|
||||
}
|
||||
],
|
||||
"isExternal": false,
|
||||
|
||||
@ -3868,17 +3868,7 @@
|
||||
"root": "/libs/nx-packages/powerpack-s3-cache",
|
||||
"source": "/libs/nx-packages/powerpack-s3-cache/src",
|
||||
"executors": {},
|
||||
"generators": {
|
||||
"/nx-api/powerpack-s3-cache/generators/init": {
|
||||
"description": "Initialize the S3 Cache",
|
||||
"file": "external-generated/packages/powerpack-s3-cache/generators/init.json",
|
||||
"hidden": false,
|
||||
"name": "init",
|
||||
"originalFilePath": "/libs/nx-packages/powerpack-s3-cache/src/generators/init/schema.json",
|
||||
"path": "/nx-api/powerpack-s3-cache/generators/init",
|
||||
"type": "generator"
|
||||
}
|
||||
},
|
||||
"generators": {},
|
||||
"path": "/nx-api/powerpack-s3-cache"
|
||||
},
|
||||
"powerpack-shared-fs-cache": {
|
||||
|
||||
@ -81,3 +81,29 @@ Finally, you need to configure your Nx cache in the `nx.json` file. The `contain
|
||||
| --------------- | -------------------------------- |
|
||||
| **container** | The name of the container to use |
|
||||
| **accountName** | The name of blob storage account |
|
||||
|
||||
# Cache Modes
|
||||
|
||||
By default, Nx will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
|
||||
|
||||
Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read-only` or `no-cache` in the `nx.json` file.
|
||||
|
||||
```jsonc {% fileName="nx.json" %}
|
||||
{
|
||||
"azure": {
|
||||
// ...
|
||||
"localMode": "read-only"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The cache mode in CI can also be configured by setting `ciMode` to `read-only` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read-only` or `no-cache` in the CI environment.
|
||||
|
||||
```jsonc {% fileName="nx.json" %}
|
||||
{
|
||||
"azure": {
|
||||
// ...
|
||||
"ciMode": "read-only"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@ -80,3 +80,29 @@ Finally, you need to configure your Nx cache in the `nx.json` file. The `bucket`
|
||||
| **Property** | **Description** |
|
||||
| ------------ | ----------------------------- |
|
||||
| **bucket** | The name of the bucket to use |
|
||||
|
||||
# Cache Modes
|
||||
|
||||
By default, Nx will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
|
||||
|
||||
Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read-only` or `no-cache` in the `nx.json` file.
|
||||
|
||||
```jsonc {% fileName="nx.json" %}
|
||||
{
|
||||
"gcs": {
|
||||
// ...
|
||||
"localMode": "read-only"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The cache mode in CI can also be configured by setting `ciMode` to `read-only` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read-only` or `no-cache` in the CI environment.
|
||||
|
||||
```jsonc {% fileName="nx.json" %}
|
||||
{
|
||||
"gcs": {
|
||||
// ...
|
||||
"ciMode": "read-only"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@ -152,3 +152,31 @@ Below is an example on how to connect to MinIO:
|
||||
| **endpoint** | The custom endpoint to upload artifacts to. If endpoint is not defined, the default AWS endpoint is used |
|
||||
| **accessKeyId** | AWS Access Key ID (optional if `AWS_ACCESS_KEY_ID` is set in the environment) |
|
||||
| **secretAccessKey** | AWS secret access key (optional if `AWS_SECRET_ACCESS_KEY` is set in the environment) |
|
||||
|
||||
# Cache Modes
|
||||
|
||||
By default, Nx will try to write and read from the remote cache while running locally. This means that permissions must be set for users who are expected to access the remote cache.
|
||||
|
||||
Nx will only show warnings when the remote cache is not writable. You can disable these warnings by setting `localMode` to `read-only` or `no-cache` in the `nx.json` file.
|
||||
|
||||
```jsonc {% fileName="nx.json" %}
|
||||
{
|
||||
"s3": {
|
||||
"region": "us-east-1",
|
||||
"bucket": "my-bucket",
|
||||
"localMode": "read-only"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
The cache mode in CI can also be configured by setting `ciMode` to `read-only` or `no-cache` in the `nx.json` file. Or setting `NX_POWERPACK_CACHE_MODE` to `read-only` or `no-cache` in the CI environment.
|
||||
|
||||
```jsonc {% fileName="nx.json" %}
|
||||
{
|
||||
"s3": {
|
||||
"region": "us-east-1",
|
||||
"bucket": "my-bucket",
|
||||
"ciMode": "read-only"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@ -17,7 +17,10 @@ The following environment variables are ones that you can set to change the beha
|
||||
| NX_WORKSPACE_DATA_DIRECTORY | string | The project graph cache and some other internal nx caches are stored in `.nx/workspace-data` by default. Set this variable to use a different directory. |
|
||||
| NX_PARALLEL | number | The number of tasks Nx should run in parallel. Overrides any configured value inside nx.json |
|
||||
| NX_RUNNER | string | The name of task runner from the config to use. Can be overridden on the command line with `--runner`. Not read if `NX_TASKS_RUNNER` is set. |
|
||||
| NX_SKIP_NX_CACHE | boolean | Rerun the tasks even when the results are available in the cache |
|
||||
| NX_SKIP_NX_CACHE | boolean | Rerun the tasks even when the results are available in the cache. |
|
||||
| NX_DISABLE_NX_CACHE | boolean | Rerun the tasks even when the results are available in the cache. |
|
||||
| NX_SKIP_REMOTE_CACHE | boolean | Disable all remote caching features. This means that the remote cache will not be read from or written to. Includes Nx Cloud and Powerpack Caches. |
|
||||
| NX_DISABLE_REMOTE_CACHE | boolean | Disable all remote caching features. This means that the remote cache will not be read from or written to. Includes Nx Cloud and Powerpack Caches. |
|
||||
| NX_TASKS_RUNNER | string | The name of task runner from the config to use. Can be overridden on the command line with `--runner`. Preferred over `NX_RUNNER`. |
|
||||
| NX_TASKS_RUNNER_DYNAMIC_OUTPUT | boolean | If set to `false`, will use non-dynamic terminal output strategy (what you see in CI), even when you terminal can support the dynamic version |
|
||||
| NX_VERBOSE_LOGGING | boolean | If set to `true`, will print debug information useful for troubleshooting |
|
||||
|
||||
@ -814,8 +814,6 @@
|
||||
- [powerpack-s3-cache](/nx-api/powerpack-s3-cache)
|
||||
- [documents](/nx-api/powerpack-s3-cache/documents)
|
||||
- [Overview](/nx-api/powerpack-s3-cache/documents/overview)
|
||||
- [generators](/nx-api/powerpack-s3-cache/generators)
|
||||
- [init](/nx-api/powerpack-s3-cache/generators/init)
|
||||
- [powerpack-shared-fs-cache](/nx-api/powerpack-shared-fs-cache)
|
||||
- [documents](/nx-api/powerpack-shared-fs-cache/documents)
|
||||
- [Overview](/nx-api/powerpack-shared-fs-cache/documents/overview)
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user