From 13c06eff6a821aa682e5b49f4b5998654d0512cc Mon Sep 17 00:00:00 2001 From: Julianne Fermi Date: Wed, 16 Oct 2024 09:44:06 -0500 Subject: [PATCH 1/3] Add YouTube Videos Test Workflows: https://www.youtube.com/embed/iHUTYT6L2Ns Test Workflows - Test Suites: https://youtube.com/embed/kvcq-J_ZhVA Postman: https://www.youtube.com/embed/7HAwEtFDwvU ArgoCD: https://testkube.io/blog/a-gitops-powered-kubernetes-testing-machine-with-argocd-and-testkube --- docs/articles/argocd-integration.md | 4 ++-- docs/articles/defining-tests.md | 2 +- docs/articles/examples/postman-basic.md | 5 ++++ docs/articles/test-workflows-test-suites.md | 18 ++++++++------ .../{test-workflows.md => test-workflows.mdx} | 24 ++++++++++++++++++- docs/articles/triggering-tests.md | 2 +- 6 files changed, 43 insertions(+), 12 deletions(-) rename docs/articles/{test-workflows.md => test-workflows.mdx} (95%) diff --git a/docs/articles/argocd-integration.md b/docs/articles/argocd-integration.md index 91b45c89..82ded33e 100644 --- a/docs/articles/argocd-integration.md +++ b/docs/articles/argocd-integration.md @@ -1,11 +1,11 @@ # Using Testkube with ArgoCD -This document describes how you can use Testkube with ArgoCD. As a prerequisite you should have good understanding +This document describes how you can use Testkube with [ArgoCD](https://argo-cd.readthedocs.io/en/stable/). As a prerequisite, you should have good understanding of both Testkube, ArgoCD and GitOps principles. :::tip For a high-level introduction to using Testkube with ArgoCD including a step-by-step tutorial, please check out -our [GitOps blogpost](https://testkube.io/blog/a-gitops-powered-kubernetes-testing-machine-with-argocd-and-testkube). +our [GitOps blogpost](https://testkube.io/blog/a-gitops-powered-kubernetes-testing-machine-with-argocd-and-testkube) and watch our YouTube video ::: ## Managing Testkube CRDs with ArgoCD diff --git a/docs/articles/defining-tests.md b/docs/articles/defining-tests.md index d4bde81e..2bafa74d 100644 --- a/docs/articles/defining-tests.md +++ b/docs/articles/defining-tests.md @@ -13,7 +13,7 @@ Defining test executions is most commonly done by DevOps/Build engineers, based ## Defining Test Execution in Testkube -Testkube uses [Test Workflows](../articles/test-workflows.md) as a generic abstraction for defining how your tests are executed. Test Workflows uses a declarative YAML vocabulary specifically designed for executing tests, with built-in functionality for: +Testkube uses [Test Workflows](../articles/test-workflows.mdx) as a generic abstraction for defining how your tests are executed. Test Workflows uses a declarative YAML vocabulary specifically designed for executing tests, with built-in functionality for: - Retrieving tests from Git repositories, inline files and external volumes. - Executing any test or testing tool available as a Docker image. diff --git a/docs/articles/examples/postman-basic.md b/docs/articles/examples/postman-basic.md index 8014df1b..46e791ce 100644 --- a/docs/articles/examples/postman-basic.md +++ b/docs/articles/examples/postman-basic.md @@ -19,3 +19,8 @@ After execution, you can see the log output from the test executions under the e Below is an example workflow for executing the Postman collection using an official Testkube Template. + + :::note +Please visit YouTube to watch our video on how to Simplify API Testing in Kubernetes with Postman and Testkube: + +::: \ No newline at end of file diff --git a/docs/articles/test-workflows-test-suites.md b/docs/articles/test-workflows-test-suites.md index bb7fa069..9d877a17 100644 --- a/docs/articles/test-workflows-test-suites.md +++ b/docs/articles/test-workflows-test-suites.md @@ -10,7 +10,11 @@ import RequiresCommercialWorkflows from "./_commercial-workflows-note.mdx" With Test Workflows it is possible to run downstream Test Workflows and Tests with `execute` operation, similarly to what you can do in Test Suites. -## Advantages over original Test Suite +Watch Test Workflows in action to create comprehensive system tests: + + + +## Advantages Over Original Test Suites As it is regular Test Workflow, where a single step is dispatching downstream Test Workflows and Tests, the execution is very flexible. You can: @@ -98,7 +102,7 @@ To run Tests as part of the `execute` step, you have to add its reference in the You need to provide `name`, along with optional `executionRequest` values for parametrization, that are similar to the regular Test execution request. -### Controlling the concurrency level +### Controlling the Concurrency Level You can use `parallelism` property to control how many Test Workflows and Tests will be running at once. @@ -138,7 +142,7 @@ spec: -## Nesting workflows +## Nesting Workflows Workflows can be nested - workflow can execute workflow(s) executing other workflow(s). [**Parallelism**](#controlling-the-concurrency-level) can then be used to control the execution flow. Example: @@ -184,11 +188,11 @@ spec: - name: soapui-workflow-suite ``` -## Passing input from files +## Passing Input from Files It may happen that you will need to pass information from the file system. You can either pass the files using Test Workflow expressions (like `file("./file-content.txt")`) or using a `tarball` syntax. -### Specific files +### Specific Files You can easily use Test Workflow expressions to fetch some files and send them as a configuration variable: @@ -215,7 +219,7 @@ spec: script: '{{ file("/data/repo/test/k6/executor-tests/k6-smoke-test-without-envs.js") }}' ``` -### Multiple files transfer +### Multiple Files Transfer To transfer multiple files, similarly to `transfer` in [**Parallel Steps**](./test-workflows-parallel.md#copying-content-inside), you can use a `tarball` syntax that will pack selected files and return the URL to download them: @@ -261,7 +265,7 @@ spec: - shell: tree /data/repo ``` -### Matrix and sharding +### Matrix and Sharding The `execute` operation supports matrix and sharding, to run multiple replicas and/or distribute the load across multiple runs. It is supported by regular matrix/sharding properties (`matrix`, `shards`, `count` and `maxCount`) for each Test Workflow or Test reference. diff --git a/docs/articles/test-workflows.md b/docs/articles/test-workflows.mdx similarity index 95% rename from docs/articles/test-workflows.md rename to docs/articles/test-workflows.mdx index 35ab98be..772001b2 100644 --- a/docs/articles/test-workflows.md +++ b/docs/articles/test-workflows.mdx @@ -1,9 +1,30 @@ # Test Workflows ## Introduction + +import TwoColumns from '@site/src/components/TwoColumns'; + + + +

+ +

Test Workflows are an easy and extremely powerful way to define and run your tests in -your Kubernetes clusters. Thanks to their flexibility, Test Workflows solve many of the +your Kubernetes clusters. +

+ + + +

Thanks to their flexibility, Test Workflows solve many of the problems that can occur with standard Tests, including: +

+ + } + right={

+ +

} +/> - Running Tests using different testing tool versions and dependencies. - Defining multiple steps for the execution of the tests. @@ -578,3 +599,4 @@ Status: Name: k6-workflow Namespace: testkube ``` + diff --git a/docs/articles/triggering-tests.md b/docs/articles/triggering-tests.md index 77953387..795b08e3 100644 --- a/docs/articles/triggering-tests.md +++ b/docs/articles/triggering-tests.md @@ -17,7 +17,7 @@ The decoupling of test definition and execution from your CI/CD is one of the mo - From your CI/CD workflows using one of our [CI/CD integrations](../articles/cicd-overview.mdx). - In response to Kubernetes events using [Triggers](../articles/test-triggers). - Manually via the [CLI](../articles/install/1-cli.mdx) or the [Testkube Dashboard](../articles/testkube-dashboard.md). -- At a recurring schedule using [Test Workflow Scheduling](../articles/test-workflows.md). +- At a recurring schedule using [Test Workflow Scheduling](../articles/test-workflows.mdx). - From any other tool using the [Testkube REST API](/openapi/overview). ![CI/CD Integrations](../img/concepts-cicd-integrations.png) From c93d89e7051e54ca89ab375ea0dba68209abe8a3 Mon Sep 17 00:00:00 2001 From: Julianne Fermi Date: Thu, 17 Oct 2024 07:46:41 -0500 Subject: [PATCH 2/3] Update argocd-integration.md --- docs/articles/argocd-integration.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/articles/argocd-integration.md b/docs/articles/argocd-integration.md index e8290707..db506411 100644 --- a/docs/articles/argocd-integration.md +++ b/docs/articles/argocd-integration.md @@ -5,7 +5,8 @@ of both Testkube, ArgoCD and GitOps principles. :::tip For a high-level introduction to using Testkube with ArgoCD including a step-by-step tutorial, please check out -our [GitOps blogpost](https://testkube.io/blog/a-gitops-powered-kubernetes-testing-machine-with-argocd-and-testkube) and watch our YouTube video +our [GitOps blogpost](https://testkube.io/blog/a-gitops-powered-kubernetes-testing-machine-with-argocd-and-testkube) and watch our YouTube video: + ::: ## Managing Testkube CRDs with ArgoCD From e4a2d21209514adf9b9ab3b1156026244d2b77bf Mon Sep 17 00:00:00 2001 From: Julianne Fermi Date: Fri, 18 Oct 2024 10:55:17 -0500 Subject: [PATCH 3/3] Add YouTube Videos Add Gatling video -https://www.youtube.com/watch?v=mgnwhg9KZ2I&t=3s. Clean up spacing and sizing of videos. --- docs/articles/argocd-integration.md | 3 ++- docs/articles/examples/gatling-basic.md | 4 ++++ docs/articles/examples/postman-basic.md | 2 +- docs/articles/test-workflows-test-suites.md | 2 +- 4 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/articles/argocd-integration.md b/docs/articles/argocd-integration.md index 82ded33e..110a8f2a 100644 --- a/docs/articles/argocd-integration.md +++ b/docs/articles/argocd-integration.md @@ -5,7 +5,8 @@ of both Testkube, ArgoCD and GitOps principles. :::tip For a high-level introduction to using Testkube with ArgoCD including a step-by-step tutorial, please check out -our [GitOps blogpost](https://testkube.io/blog/a-gitops-powered-kubernetes-testing-machine-with-argocd-and-testkube) and watch our YouTube video +our [GitOps blogpost](https://testkube.io/blog/a-gitops-powered-kubernetes-testing-machine-with-argocd-and-testkube) and watch our YouTube video: +
::: ## Managing Testkube CRDs with ArgoCD diff --git a/docs/articles/examples/gatling-basic.md b/docs/articles/examples/gatling-basic.md index 575d1237..b6ae587b 100644 --- a/docs/articles/examples/gatling-basic.md +++ b/docs/articles/examples/gatling-basic.md @@ -28,3 +28,7 @@ The uploaded report is available in the Artifacts tab: + +See how to effortlessly perform load testing in Kubernetes using Gatling and Testkube from the Testkube UI here: + +
diff --git a/docs/articles/examples/postman-basic.md b/docs/articles/examples/postman-basic.md index 46e791ce..609098fc 100644 --- a/docs/articles/examples/postman-basic.md +++ b/docs/articles/examples/postman-basic.md @@ -22,5 +22,5 @@ Below is an example workflow for executing the Postman collection using an offic :::note Please visit YouTube to watch our video on how to Simplify API Testing in Kubernetes with Postman and Testkube: - +
::: \ No newline at end of file diff --git a/docs/articles/test-workflows-test-suites.md b/docs/articles/test-workflows-test-suites.md index 9d877a17..f8dee04b 100644 --- a/docs/articles/test-workflows-test-suites.md +++ b/docs/articles/test-workflows-test-suites.md @@ -12,7 +12,7 @@ similarly to what you can do in Test Suites. Watch Test Workflows in action to create comprehensive system tests: - +
## Advantages Over Original Test Suites