Skip to content

Commit ddaa030

Browse files
authored
Chore: Correct documentation for the self-hosted executors (#3999)
1 parent 5e9f405 commit ddaa030

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/cloud/features/scheduler/scheduler.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ Self-hosted executors as the name indicates are self-hosted workers that take on
169169

170170
Exact configuration is left to the user and will vary based on the infrastructure and setup of the user, for example the executors could be run on a Kubernetes cluster or as a standalone pair of Docker containers depending on the user's infrastructure. The following details are an example of how this is done for a Postgres data warehouse and a pair of local containers running in docker.
171171

172-
Tobiko Cloud requires 2 docker instances to be running, one to pick up runs and one for plans. The entrypoint for both is `executor run` and `executor plan` respectively. The executor container can be found on [Docker Hub](https://hub.docker.com/r/tobikodata/tcloud). In addition to running the container, the user will need to configure the executor with environment variables that point to Tobiko Cloud as well as the data warehouse.
172+
Tobiko Cloud requires 2 docker instances to be running, one to pick up runs and one for plan applications. The entrypoint for both is `executor run` and `executor apply` respectively. The executor container can be found on [Docker Hub](https://hub.docker.com/r/tobikodata/tcloud). In addition to running the container, the user will need to configure the executor with environment variables that point to Tobiko Cloud as well as the data warehouse.
173173

174174
To connect to the Tobiko Cloud, the user will need to provide the following environment variables, replaced with the user's own values.
175175

@@ -203,10 +203,10 @@ Once you have set up both sets of environment variables in a file named `local.e
203203

204204
```shell
205205
docker run -d --env-file local.env tobikodata/tcloud:latest -- executor run
206-
docker run -d --env-file local.env tobikodata/tcloud:latest -- executor plan
206+
docker run -d --env-file local.env tobikodata/tcloud:latest -- executor apply
207207
```
208208

209-
After the executors are properly configured, they will appear in the cloud UI where they can be used to execute plans and scheduled tasks.
209+
After the executors are properly configured, they will appear in the cloud UI where they can be used to apply plans and execute scheduled runs.
210210

211211
![executors](../scheduler/executors.png)
212212

@@ -226,7 +226,7 @@ In production settings, we recommend setting up health checks as well, as these
226226

227227
```shell
228228
docker run -d --env-file local.env tobikodata/tcloud:latest -- executor run --check
229-
docker run -d --env-file local.env tobikodata/tcloud:latest -- executor plan --check
229+
docker run -d --env-file local.env tobikodata/tcloud:latest -- executor apply --check
230230
```
231231

232232
For environments that ignore the container's entrypoint, for example in the case of Kubernetes healthchecks, the health check is invoked as follows:
@@ -243,14 +243,14 @@ readinessProbe:
243243
```
244244

245245
```yaml
246-
# For the plan executor
246+
# For the apply executor
247247
readinessProbe:
248248
exec:
249249
command:
250250
- "/app/pex"
251251
- "executor"
252-
- "plan"
252+
- "apply"
253253
- "--check"
254254
```
255255

256-
Each executor type (run or plan) should have its own health check implemented to ensure proper monitoring of both components.
256+
Each executor type (run or apply) should have its own health check implemented to ensure proper monitoring of both components.

0 commit comments

Comments
 (0)