Skip to content

Commit

Permalink
[automated commit] Bump docs to versions 2.19.0, 1.53.4
Browse files Browse the repository at this point in the history
  • Loading branch information
leorossi authored and github-actions[bot] committed Dec 4, 2024
1 parent 1430237 commit a9a3749
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 11 deletions.
15 changes: 15 additions & 0 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ Welcome to Platformatic. Available commands are:
* `resolve` - resolve Platformatic Runtime external services
* `client` - generate a Platformatic client.
* `build` - builds all services.
* `install` - install all dependencies of an application and its services.
* `compile` - compile all typescript plugins.
* `help` - display this message.
* `help <command>` - show more information about a command.
Expand Down Expand Up @@ -194,6 +195,7 @@ Options:
* `-c, --config FILE` - Path to the runtime configuration file.
* `-u, --username string` - Username for the service repository.
* `-p, --password string` - Password for the service repository.
* `-P, --package-manager EXECUTABLE`: Use an alternative package manager to install dependencies (the default is to autodetect it).

Platformatic resolve command resolves runtime services that have the `url` in their configuration.
By default services are cloned with `git` to the `external` directory inside the runtime directory.
Expand Down Expand Up @@ -290,6 +292,19 @@ platformatic client <command>
```


### install

Install all dependencies of an application and its services.

```bash
platformatic install
```

Options:

* `-p, --production`: Only install production dependencies.
* `-P, --package-manager EXECUTABLE`: Use an alternative package manager (the default is to autodetect it).

#### help

Create a Fastify plugin that exposes a client for a remote OpenAPI or GraphQL API.
Expand Down
18 changes: 11 additions & 7 deletions docs/runtime/_shared-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,10 @@ If this property is present, then the services will not be reordered according t
`getBootstrapDependencies` function and they will be started in the order they are defined in
the configuration file.

### `resolvedServicesBasePath`

The base path, relative to the configuration file to store resolved services. Each service will be saved in `{resolvedServicesBasePath}/{id}`. Default: `external`.

### `entrypoint`

The Platformatic Runtime's entrypoint is a microservice that is exposed
Expand Down Expand Up @@ -125,13 +129,13 @@ Configures the health check for each worker. This is enabled only if `restartOnE

The object supports the following settings:

* `enabled` (`boolean`): If to enable the health check. Default: `true`.
* `interval` (`number`): The interval between checks in milliseconds. Default: `30000`.
* `gracePeriod`: How long after the service started before starting to perform health checks. Default: `30000`.
* `maxUnhealthyChecks`: The number of consecutive failed checks before killing the worker. Default: `1`.
* `maxELU`: The maximum allowed Event Loop Utilization. The value must be a percentage between `0` and `1`. Default: `0.95`.
* `maxHeapUsed`: The maximum allowed memory utilization. The value must be a percentage between `0` and `1`. Default: `0.95`.
* `maxHeapTotal`: The maximum allowed memory allocatable by the process. The value must be an amount in bytes. Default: `4G`.
- `enabled` (`boolean`): If to enable the health check. Default: `true`.
- `interval` (`number`): The interval between checks in milliseconds. Default: `30000`.
- `gracePeriod`: How long after the service started before starting to perform health checks. Default: `30000`.
- `maxUnhealthyChecks`: The number of consecutive failed checks before killing the worker. Default: `1`.
- `maxELU`: The maximum allowed Event Loop Utilization. The value must be a percentage between `0` and `1`. Default: `0.95`.
- `maxHeapUsed`: The maximum allowed memory utilization. The value must be a percentage between `0` and `1`. Default: `0.95`.
- `maxHeapTotal`: The maximum allowed memory allocatable by the process. The value must be an amount in bytes. Default: `4G`.

### `telemetry`

Expand Down
24 changes: 20 additions & 4 deletions docs/watt/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ Arguments:
- `root`: The directory where to create the application (the default is the current directory)
- `entrypoint`: The name of the entrypoint service

Options:

- `-p, --package-manager`: Use an alternative package manager (the default is `npm`)

## `build`

Builds all services of an application.
Expand All @@ -19,6 +23,19 @@ Arguments:

- `root`: The directory containing the application (the default is the current directory)

## `install`

Install all dependencies of an application and its services.

Arguments:

- `root`: The directory containing the application (the default is the current directory)

Options:

- `-p, --production`: Only install production dependencies
- `-P, --package-manager`: Use an alternative package manager (the default is to autodetect it)

## `dev`

Starts an application in development mode.
Expand Down Expand Up @@ -160,11 +177,9 @@ Options:

## `resolve`

Resolves all external services. The command operates on all services which have the `url` fields defined.

To change the directory where a service is cloned, you can set the `path` property in the service configuration.
Resolves all external services. The command operates on all services which have the `url` fields defined and the path specified as environment variable.

After cloning the service, the resolve command will set the relative path to the service in the wattpm configuration file.
After cloning the service, the resolve command will set the relative path to the service in the `.env` file.

Arguments:

Expand All @@ -175,6 +190,7 @@ Options:
- `-u, --username <value>`: The username to use for HTTP URLs
- `-p, --password <value>`: The password to use for HTTP URLs
- `-s, --skip-dependencies`: Do not install services dependencies
- `-P, --package-manager`: Use an alternative package manager (the default is to autodetect it)

## `help`

Expand Down

0 comments on commit a9a3749

Please sign in to comment.