Merge pull request #2015 from trloftsh/pipeline_content_updated_tr

Pipeline content updated tr [WIP]

Author: LukasGentele

docs/pages/configuration/pipelines/functions/build_images.mdx

@@ -7,26 +7,55 @@ import FragmentConfigOverwriteFlags from '../../../fragments/config-overwrite-fl
 
 The function `build_images` builds either all images (`--all` flag) or the images provided as arguments (e.g. `build_images api ui`). Images are, by default, processed in parallel.
 
+## Arguments
 
-## Args
+None
 
+### Usage
+
+```
+build_image image1 image2
+
+```
 
 ## Flags
 
+By default, flags are disabled. If any of the flags below are enabled, the following actions are taken.
+
 ### `--all`
 
+All images will be built.
+
 ### `--tag / -t`
 
+The build image tag will be returned.
+
+### `--skip-build`
+
+The image will not be built.
+
+### `--skip-push`
+
+The image will not be pushed to a container registry.
+
+### `--skip-push-on-local-kubernetes`
+
+The image will not be pushed if the current Kubernetes config was detected to be a local cluster like docker-desktop or minikube.
+
 ### `--force-rebuild`
 
-### `--max-concurrent`
+The images will be forced to be rebuilt.
 
 ### `--sequential`
 
-### `--skip`
+Images will be built in sequential order, one after another.
 
-### `--skip-push`
+### `--max-concurrent-builds`
+
+An integer that represents the maximum number of images that can be built concurrently.
 
-### `--skip-push-on-local-kubernetes`
+
+## Config Overwrite Flags
 
 <FragmentConfigOverwriteFlags/>
+

docs/pages/configuration/pipelines/functions/create_deployments.mdx

@@ -2,3 +2,45 @@
 title: Function create_deployments
 sidebar_label: create_deployments
 ---
+
+This function creates a new deployment for a pipeline.
+
+## Arguments
+
+### `--skip-deploy`
+
+The deployment will be skipped.
+
+### `--force-deploy`
+
+The deployment will be forced to run.
+
+### `--sequential`
+
+The deployments will be deployed sequentially, one after another.
+
+### `--render`
+
+The rendered manifests will be printed to the console (stdout) instead of being deployed.
+
+## Usage
+
+```
+create_deployments--all
+```
+
+```
+create_deployments deployment1 deployment2
+```
+
+## Flags
+
+By default, flags are disabled. If any of the flags below are enabled, the following actions are taken.
+
+### `--all`
+
+Deploys all existing deployments.
+
+## Config Overwrite Flags
+
+TODO: Import reusable fragmennts here

docs/pages/configuration/pipelines/functions/ensure_pull_secrets.mdx

@@ -2,3 +2,27 @@
 title: Function ensure_pull_secrets
 sidebar_label: ensure_pull_secrets
 ---
+
+This function validates existing pull secrets for a pod.
+
+## Arguments
+
+None
+
+## Usage
+
+```
+ensure_pull_secrets pullSecret1 pullSecret2
+```
+
+## Flags
+
+By default, flags are disabled. If any of the flags below are enabled, the following actions are taken.
+
+### `-all`
+
+If enabled, ensures all pull secrets are created in the target Kubernetes namespace.
+
+## Config Overwrite Fiags
+
+TODO: Add config overwrite flags here

docs/pages/configuration/pipelines/functions/exec_container.mdx

@@ -2,3 +2,41 @@
 title: Function exec_container
 sidebar_label: exec_container
 ---
+
+This function enables you to execute commands inside a container.
+
+## Arguments
+
+### `--image-selector`
+
+The image selector to be used when selecting the container.
+
+### `--label-selector`
+
+The label selector to be used when selecting the container.
+
+### `--container`
+
+The container to be used.
+
+### `--namespace`
+
+The namespace to be used.
+
+## Usage
+
+```
+exec_container --image-selector=ubuntu -- echo "Hello from within ubuntu container!"
+```
+
+## Flags
+
+By default, flags are disabled. If any of the flags below are enabled, the following actions are taken.
+
+### `--diable-wait`
+
+If enabled, will not wait for the container to be ready.
+
+### `--timeout`
+
+The amount of time to wait for a container to be ready. The default is 5 minutes.

docs/pages/configuration/pipelines/functions/get_config_value.mdx

@@ -2,3 +2,19 @@
 title: Function get_config_value
 sidebar_label: get_config_value
 ---
+
+This function retrieves the value for an existing configuration.
+
+## Arguments
+
+None
+
+## Usage
+
+```
+get_config_value [configValue1]
+```
+
+## Flags
+
+None

docs/pages/configuration/pipelines/functions/get_image.mdx

@@ -2,3 +2,25 @@
 title: Function get_image
 sidebar_label: get_image
 ---
+
+This function retrieves an image or image tag.
+
+## Arguments
+
+### `--dependency`
+
+Retrieves the image or image tag from the named dependency.
+
+### `--only`
+
+Displays either the image, or the tag, but not both.
+
+## Usage
+
+```
+get_image [--only=image|tag] [--dependency=DEPENDENCY] [image_name]
+```
+
+## Flags
+
+None

docs/pages/configuration/pipelines/functions/purge_deployments.mdx

@@ -2,3 +2,27 @@
 title: Function purge_deployments
 sidebar_label: purge_deployments
 ---
+
+This function removes a deployment.
+
+## Arguments
+
+None
+
+## Usage
+
+```
+purge_deployments deployment1 deployment2
+```
+
+## Flags
+
+By default, flags are disabled. If any of the flags below are enabled, the following actions are taken.
+
+### `--all`
+
+Purges all existing deployments.
+
+### `--sequential`
+
+Purges all existing deployments in sequential order, one after another.

docs/pages/configuration/pipelines/functions/run_default_pipeline.mdx

@@ -2,3 +2,19 @@
 title: Function run_default_pipeline
 sidebar_label: run_default_pipeline
 ---
+
+Runs the default pipeline.
+
+## Arguments
+
+None
+
+## Usage
+
+```
+run_default_pipeline
+```
+
+## Flags
+
+None

docs/pages/configuration/pipelines/functions/run_dependency_pipelines.mdx

@@ -2,3 +2,37 @@
 title: Function run_dependency_pipelines
 sidebar_label: run_dependency_pipelines
 ---
+
+Runs dependencies for pipelines.
+
+## Arguments
+
+### `--pipeline`
+
+The pipeline that is executed from the dependency.
+
+### `--exclude`
+
+The dependencies to be excluded from the pipeline if the --all flag is used.
+
+### `--only`
+
+The dependencies to be included in the pipeline.
+
+## Usage
+
+```
+run_dependency_pipelines [buildDependencies] [renderDependencies]
+```
+
+## Flags
+
+By default, all flags are disabled. If any of these flags are enabled, the follwing actions will take place.
+
+### `--sequential`
+
+The dependencies will be run in sequential order, one after another.
+
+### `--all`
+
+If enabled, all dependencies will be run.

docs/pages/configuration/pipelines/functions/run_pipelines.mdx

@@ -2,3 +2,37 @@
 title: Function run_pipelines
 sidebar_label: run_pipelines
 ---
+
+This function triggers a new pipeline to be run. A pipeline defines what DevSpace should do.
+
+A pipeline consists of one or more jobs that are run in parallel and can depend on each other. Each job consists of one or more conditional steps that are executed in order.
+
+## Arguments
+
+None
+
+## Usage
+
+```
+run_pipeline [pipeline1]
+```
+
+## Flags
+
+By default, flags are disabled. If any of the flags below are enabled, the following actions are taken.
+
+### `--env`
+
+Passes environment variables to the pipelines.
+
+### `--background`
+
+Runs the pipeline in the background.
+
+### `--sequential`
+
+Runs the pipelines in sequential order, one after another.
+
+## Config Overwrite Flags
+
+#TODO: This needs to be a reusable section