From 6bd31ed115face746b4bea0edf90edf1dcf31476 Mon Sep 17 00:00:00 2001 From: AJ Emerich Date: Thu, 30 Jan 2025 15:46:37 +0100 Subject: [PATCH] (docs): Move Json schema from tutorial to troubleshooting (#2154) * (docs): Move Json schema from tutorial to troubleshooting * remove from troubleshooting Already in Flows page, no need for so much duplication --- .../docs/01.getting-started/03.tutorial.md | 33 ------------------- .../16.troubleshooting.md | 13 ++++---- 2 files changed, 6 insertions(+), 40 deletions(-) diff --git a/content/docs/01.getting-started/03.tutorial.md b/content/docs/01.getting-started/03.tutorial.md index 3e73f5fc01..7af7bd4778 100644 --- a/content/docs/01.getting-started/03.tutorial.md +++ b/content/docs/01.getting-started/03.tutorial.md @@ -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/"} :: diff --git a/content/docs/09.administrator-guide/16.troubleshooting.md b/content/docs/09.administrator-guide/16.troubleshooting.md index 0e66904523..90bca9e663 100644 --- a/content/docs/09.administrator-guide/16.troubleshooting.md +++ b/content/docs/09.administrator-guide/16.troubleshooting.md @@ -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. @@ -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: @@ -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. @@ -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. @@ -214,4 +214,3 @@ volumes: - /var/run/docker.sock:/var/run/docker.sock - /home/kestra:/home/kestra ``` -