Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/kestra-io/docs
Browse files Browse the repository at this point in the history
  • Loading branch information
anna-geller committed Jan 30, 2025
2 parents 2b3189b + 6bd31ed commit 2abc1ad
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 40 deletions.
33 changes: 0 additions & 33 deletions content/docs/01.getting-started/03.tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,38 +16,5 @@ This tutorial guides you through **key concepts** in Kestra. We build upon the "

We then dive into `parallel` task execution, error handling, as well as custom scripts and microservices running in isolated containers. Let's get started!

## Using JSON Schema to Validate a Flow

Kestra provides a JSON Schema to validate your flow definitions. This ensures that your flows are correctly structured and helps catch errors early in the development process.

### JSON Schema in VSCode

To use the JSON Schema in Visual Studio Code (VSCode), follow these steps:

1. Install the [YAML extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-yaml) by Red Hat.
2. Open your VSCode settings (`Ctrl+,` or `Cmd+,`).
3. Search for `YAML: Schemas` and click on `Edit in settings.json`.
4. Add the following configuration to associate the Kestra JSON Schema with your flow files:

```json
{
"yaml.schemas": {
"https://your-kestra-instance.com/api/v1/schemas/flow.json": "/*.yaml"
}
}
```

Replace `https://your-kestra-instance.com/api/v1/schemas/flow.json` with the actual URL of your Kestra JSON Schema.

### Globally Available Location for JSON Schema

The JSON Schema for Kestra flows is available at the following URL:

```
https://your-kestra-instance.com/api/v1/schemas/flow.json
```

Replace `https://your-kestra-instance.com` with the actual URL of your Kestra instance.

::ChildCard{pageUrl="/docs/tutorial/"}
::
13 changes: 6 additions & 7 deletions content/docs/09.administrator-guide/16.troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ icon: /docs/icons/faq.svg
Something doesn't work as expected? Check out our advice to help you troubleshoot.


### CrashLoopBackoff when restarting all pods
## CrashLoopBackoff when restarting all pods

Question from a user: "When I restart all Kubernetes pods at once, they get stuck in a `CrashLoopBackoff` for a number of minutes before eventually resolving - Why does it happen?"

You are likely hitting the startup issue of a Java application causing failure of liveness probes. The startup can consume a lot of resources, since Java will load many classes at startup. Setting the CPU limit to `0.5` can improve the startup time of the server and should resolve the failing healthchecks.


### Unprocessable execution
## Unprocessable execution

Sometimes, things can go wrong in an unattended manner; in such situations, you can skip an execution that Kestra is not able to process.

Expand Down Expand Up @@ -62,14 +62,14 @@ kestra server executor --skip-tenants companyA
```


### Docker in Docker (DinD)
## Docker in Docker (DinD)

If you face some issues using Docker in Docker e.g. with [Script tasks](../04.workflow-components/01.tasks/02.scripts/index.md) using `DOCKER` runner, start troubleshooting by attaching the terminal: ``docker run -it --privileged docker:dind sh``. Then, use `docker logs container_ID` to get the container logs.

Also, try `docker inspect container_ID` to get more information about your Docker container. The output from this command displays details about the container, its environments, network settings, etc. This information can help you identify what might be wrong.


### Docker in Docker using Helm charts
## Docker in Docker using Helm charts

On some Kubernetes deployments, using DinD with our default Helm charts can lead to:

Expand Down Expand Up @@ -98,7 +98,7 @@ securityContext:
```
### Docker in Docker (DinD) on a Mac with ARM-based Apple silicon chip
## Docker in Docker (DinD) on a Mac with ARM-based Apple silicon chip
If you are getting an error similar to: `java.io.IOException: com.sun.jna.LastErrorException: [111] Connection refused`, it might be related to a Docker in Docker (DinD) issue.
Expand Down Expand Up @@ -193,7 +193,7 @@ services:
```
::
### tmp directory "No such file or directory"
## tmp directory "No such file or directory"
If you're encountering errors associated to the tmp directory such as "No such file or directory", there's a good chance your tmp directory isn't mounted correctly in your Kestra configuration.

Expand All @@ -214,4 +214,3 @@ volumes:
- /var/run/docker.sock:/var/run/docker.sock
- /home/kestra:/home/kestra
```

0 comments on commit 2abc1ad

Please sign in to comment.