Skip to content

Commit

Permalink
docs: Docs Cloud Rename (#4669) (#4677)
Browse files Browse the repository at this point in the history
* docs: Docs Cloud Rename (#4669)

* Docs Cloud Rename

* docs: update cli docs and add redirects

* docs: update URLs in docs

* docs: fix redirect

* docs: fix reference

* docs: fix reference

---------

Co-authored-by: Lilla Vass <lilla@kubeshop.io>

* docs: add redirects

---------

Co-authored-by: Julianne Fermi <julianne@kubeshop.io>
  • Loading branch information
vLia and jfermi committed Nov 28, 2023
1 parent 1f0db88 commit 4881e02
Show file tree
Hide file tree
Showing 38 changed files with 439 additions and 451 deletions.
370 changes: 185 additions & 185 deletions docs/docs/articles/crds-reference.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/docs/articles/deploying-from-private-registries.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Guide to Deploying Testkube from private registries
# Guide to Deploying Testkube from Private Registries

This guide shows how to deploy Testkube using images from private registries.

Expand Down
14 changes: 7 additions & 7 deletions docs/docs/articles/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

Testkube is a Kubernetes-native test orchestration and execution framework that allows you to automate the executions of your existing testing tools inside your Kubernetes cluster, removing all the complexity from your CI/CD pipelines.

To get started, you can follow the instructions in Testkube Cloud, or watch this video for a step-by-step walkthrough.
To get started, you can follow the instructions in Testkube Pro, or watch this video for a step-by-step walkthrough.

<iframe width="100%" height="315" src="https://www.youtube.com/embed/YnR5yOO8C4s?si=3xdK77wcQVpJQrwt" title="YouTube Tutorial: Installing Testkube Cloud" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
<iframe width="100%" height="315" src="https://www.youtube.com/embed/YnR5yOO8C4s?si=3xdK77wcQVpJQrwt" title="YouTube Tutorial: Installing Testkube Pro" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>


## Step 1: Sign up for Testkube Cloud
[Create an account](https://cloud.testkube.io/) using GitHub or GitLab.
## Step 1: Sign up for Testkube Pro
[Create an account](https://app.testkube.io/) using GitHub or GitLab.

![Sign in to Testkube](../img/sign-in.png)

Expand All @@ -35,10 +35,10 @@ With Testkube you can run any kind of test in Kubernetes. Check out our [native

### Validating the Installation

Testkube Cloud will notify if the installation is successful.
Testkube Pro will notify if the installation is successful.

* A green indicator means that your cluster was able to connect to the Testkube Cloud.
* A red indicator indicates that the Testkube Agent can't connect to the Testkube Cloud API (Testkube needs some time to establish a connection, max time is 2-3 minutes).
* A green indicator means that your cluster was able to connect to the Testkube Pro.
* A red indicator indicates that the Testkube Agent can't connect to the Testkube Pro API (Testkube needs some time to establish a connection, max time is 2-3 minutes).

![Validate Install](../img/validate-install.png)

Expand Down
28 changes: 14 additions & 14 deletions docs/docs/articles/github-actions.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Testkube GitHub Action

The Testkube GitHub Action installs Testkube and enables running any [Testkube CLI](https://docs.testkube.io/cli/testkube) command in a GitHub workflow. It is available on Github Marketplace <https://github.com/marketplace/actions/testkube-action>.
The action provides a flexible way to work with your pipeline and can be used with Testkube Cloud, Testkube Enterprise, and an open source Testkube platform.
The action provides a flexible way to work with your pipeline and can be used with Testkube Pro, Testkube Enterprise, and an open source Testkube platform.

## Testkube Cloud
## Testkube Pro

### How to configure Testkube CLI action for TK Cloud and run a test
### How to configure Testkube CLI action for Testkube Pro and Run a Test

To use this GitHub Action for the [Testkube Cloud](https://cloud.testkube.io/), you need to create [API token](https://docs.testkube.io/testkube-cloud/articles/organization-management/#api-tokens).
To use this GitHub Action for the [Testkube Pro](https://app.testkube.io/), you need to create an [API token](https://docs.testkube.io/testkube-pro/articles/organization-management/#api-tokens).
Then, pass the **organization** and **environment** IDs, along with the **token** and other parameters specific for your use case.

If test is already created, you may directly run it using the command `testkube run test test-name -f` . However, if you need to create a test in this workflow, please add a creation command, e.g.: `testkube create test --name test-name --file path_to_file.json`.
If a test is already created, you may directly run it using the command `testkube run test test-name -f` . However, if you need to create a test in this workflow, please add a creation command, e.g.: `testkube create test --name test-name --file path_to_file.json`.

```yaml
steps:
Expand Down Expand Up @@ -40,11 +40,11 @@ steps:
```
## Testkube OSS
### How to configure Testkube CLI action for TK OSS and run a test
### How to Configure Testkube CLI Actions for Testkube OSS and Run a Test
To connect to the self-hosted instance, you need to have **kubectl** configured for accessing your Kubernetes cluster, and simply passing optional namespace, if Testkube is not deployed in the default **testkube** namespace.
If test is already created, you may directly run it using the command `testkube run test test-name -f` . However, if you need to create a test in this workflow, please add a creation command, e.g.: `testkube create test --name test-name --file path_to_file.json`.
If a test is already created, you may run it using the command `testkube run test test-name -f` . However, if you need to create a test in this workflow, please add a creation command, e.g.: `testkube create test --name test-name --file path_to_file.json`.

```yaml
steps:
Expand All @@ -59,11 +59,11 @@ steps:

Steps to connect to your Kubernetes cluster differ for each provider. You should check the docs of your Cloud provider on how to connect to the Kubernetes cluster from GitHub Action, or check examples in this documentation for selected providers.

### How to configure Testkube CLI action for TK OSS and run a test
### How to Configure Testkube CLI Actions for Testkube OSS and Run a Test

This workflow establishes a connection to EKS cluster and creates and runs a test using TK CLI. In this example we also use GH secrets not to reveal sensitive data. Please make sure that the following points are satisfied:
This workflow establishes a connection to EKS cluster and creates and runs a test using Testkube CLI. In this example, we also use GitHub secrets not to reveal sensitive data. Please make sure that the following points are satisfied:
- The **_AwsAccessKeyId_**, **_AwsSecretAccessKeyId_** secrets should contain your AWS IAM keys with proper permissions to connect to EKS cluster.
- The **_AwsRegion_** secret should contain AWS region where EKS is
- The **_AwsRegion_** secret should contain an AWS region where EKS is.
- Tke **EksClusterName** secret points to the name of EKS cluster you want to connect.

```yaml
Expand All @@ -86,7 +86,7 @@ steps:
testkube run test test-name -f
```

### How to connect to GKE (Google Kubernetes Engine) cluster and run a test
### How to Connect to GKE (Google Kubernetes Engine) Cluster and Run a Test

This example connects to a k8s cluster in Google Cloud, creates and runs a test using Testkube GH Action. Please make sure that the following points are satisfied:
- The **_GKE Sevice Account_** should be created prior in Google Cloud and added to GH Secrets along with **_GKE Project_** value;
Expand Down Expand Up @@ -115,10 +115,10 @@ steps:
- run: |
testkube run test test-name -f
```
Please consult with the official documentation from GH on how to connect to GKE for more information: ttps://docs.github.com/en/actions/deployment/deploying-to-google-kubernetes-engine.
Please consult the official documentation from GitHub on how to connect to GKE for more information [here](https://docs.github.com/en/actions/deployment/deploying-to-google-kubernetes-engine).

### Complete Example of Working GH Actions Workflow and Testkube Tests Usage
To integrate TK Github Action into your workflow, please take a look at the example that sets up connection to GKE and creates and runs a test:
### Complete Example of Working GitHub Actions Workflow and Testkube Tests Usage
To integrate Testkube Github Actions into your workflow, please take a look at the example that sets up connection to GKE and creates and runs a test:

```yaml
name: Running Testkube Tests.
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/articles/gitlab.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Testkube Gitlab CI

The Testkube GitLab CI/CD integration facilitates the installation of Testkube and allows the execution of any [Testkube CLI](https://docs.testkube.io/cli/testkube) command within a GitLab CI/CD pipeline. This integration can be seamlessly incorporated into your GitLab repositories to enhance your CI/CD workflows.
The integration offers a versatile approach to align with your pipeline requirements and is compatible with Testkube Cloud, Testkube Enterprise, and the open-source Testkube platform. It enables GitLab users to leverage the powerful features of Testkube directly within their CI/CD pipelines, ensuring efficient and flexible test execution.
The integration offers a versatile approach to align with your pipeline requirements and is compatible with Testkube Pro, Testkube Enterprise, and the open-source Testkube platform. It enables GitLab users to leverage the powerful features of Testkube directly within their CI/CD pipelines, ensuring efficient and flexible test execution.

## Testkube Cloud
## Testkube Pro

### How to configure Testkube CLI action for TK Cloud and run a test
### How to configure Testkube CLI action for Testkube Pro and run a test

To use this Gitlab CI for [Testkube Cloud](https://cloud.testkube.io/), you need to create an [API token](https://docs.testkube.io/testkube-cloud/articles/organization-management/#api-tokens).
To use this Gitlab CI for [Testkube Pro](https://app.testkube.io/), you need to create an [API token](https://docs.testkube.io/testkube-pro/articles/organization-management/#api-tokens).
Then, pass the **organization** and **environment** IDs, along with the **token** and other parameters specific for your use case.

If a test is already created, you can run it using the command `testkube run test test-name -f` . However, if you need to create a test in this workflow, please add a creation command, e.g.: `testkube create test --name test-name --file path_to_file.json`.
Expand Down
8 changes: 4 additions & 4 deletions docs/docs/articles/jenkins.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Testkube Jenkins

The Testkube Jenkins integration streamlines the installation of Testkube, enabling the execution of any [Testkube CLI](https://docs.testkube.io/cli/testkube) command within Jenkins pipelines. This integration can be effortlessly integrated into your Jenkins setup, enhancing your continuous integration and delivery processes.
This Jenkins integration offers a versatile solution for managing your pipeline workflows and is compatible with Testkube Cloud, Testkube Enterprise, and the open-source Testkube platform. It allows Jenkins users to effectively utilize Testkube's capabilities within their CI/CD pipelines, providing a robust and flexible framework for test execution and automation.
This Jenkins integration offers a versatile solution for managing your pipeline workflows and is compatible with Testkube Pro, Testkube Enterprise, and the open-source Testkube platform. It allows Jenkins users to effectively utilize Testkube's capabilities within their CI/CD pipelines, providing a robust and flexible framework for test execution and automation.

## Testkube Cloud
## Testkube Pro

### How to configure Testkube CLI action for TK Cloud and run a test
### How to configure Testkube CLI action for Testkube Pro and run a test

To use Jenkins CI/CD for [Testkube Cloud](https://cloud.testkube.io/), you need to create an [API token](https://docs.testkube.io/testkube-cloud/articles/organization-management/#api-tokens).
To use Jenkins CI/CD for [Testkube Pro](https://app.testkube.io/), you need to create an [API token](https://docs.testkube.io/testkube-pro/articles/organization-management/#api-tokens).
Then, pass the **organization** and **environment** IDs, along with the **token** and other parameters specific for your use case.

If a test is already created, you can run it using the command `testkube run test test-name -f` . However, if you need to create a test in this workflow, please add a creation command, e.g.: `testkube create test --name test-name --file path_to_file.json`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Testkube Open Source or Testkube Cloud?
# Testkube Open Source or Testkube Pro?

Designed to integrate seamlessly with your Kubernetes clusters, Testkube offers flexibility and power. For those searching for a quicker and streamlined experience, we suggest signing up for [Testkube Cloud](https://cloud.testkube.io/). However, for organizations that prefer the hands-on approach, diving deep into the [Open Source](./testkube-oss.md) version could be the ideal choice.
Designed to integrate seamlessly with your Kubernetes clusters, Testkube offers flexibility and power. For those searching for a quicker and streamlined experience, we suggest signing up for [Testkube Pro](https://app.testkube.io/). However, for organizations that prefer the hands-on approach, diving deep into the [Open Source](./testkube-oss.md) version could be the ideal choice.

Please refer to the table below to determine which version of Testkube best fits your needs.

## Testkube OSS vs. Testkube Cloud: At a Glance
## Testkube OSS vs. Testkube Pro: At a Glance

| | OSS | Cloud/Enterprise |
| | OSS | Pro |
| :--------------------- | :--------------------------- | :-------------------------------------------------- |
| Hosted | Fully hosted on your cluster. | Hybrid - Cloud Dashboard with the Test Execution Agent on your cluster. |
| Setup | Utilize a Helm chart, you maintain it. | Simplified setup for a quicker start. [Sign in here](https://cloud.testkube.io/) for free. |
| Maintainance | Your team manages S3, MongoDB, and API resources. | Significant reduction in maintenance costs with Testkube Cloud.|
| Features | Core functionality for executing tests. | Builds upon OSS; enhanced with FREE, PRO and Enterprise features. Check [Pricing](https://testkube.io/pricing). |
| Hosted | Fully hosted on your cluster. | Hybrid - Pro Dashboard with the Test Execution Agent on your cluster. |
| Setup | Utilize a Helm chart, you maintain it. | Simplified setup for a quicker start. [Sign in here](https://app.testkube.io/) for free. |
| Maintainance | Your team manages S3, MongoDB, and API resources. | Significant reduction in maintenance costs with Testkube Pro.|
| Features | Core functionality for executing tests. | Builds upon OSS; enhanced with FREE and PRO features. Check [Pricing](https://testkube.io/pricing). |
| Support | Community Support | Advanced Support |
14 changes: 7 additions & 7 deletions docs/docs/articles/run-tests-with-github-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ To use the action in your GitHub workflow, use the ``kubeshop/testkube-run-actio

The most important options you will need are **test** and **testSuite** - you should pass a test or test suite name there.

### Testkube Cloud
To use this GitHub Action for the Testkube Cloud, you need to create an API token.
### Testkube Pro
To use this GitHub Action for Testkube Pro, you need to create an API token.

Then, pass the **organization** and **environment** IDs for the test, along with the **token** and other parameters specific for your use case:

Expand Down Expand Up @@ -106,7 +106,7 @@ with:
`testkube-run-action` is also used for running Testkube internal tests with Testkube. Workflow for Testkube Dashboard E2E tests can be found [here](https://github.com/kubeshop/testkube-dashboard/blob/develop/.github/workflows/pr_checks.yml#L28)

## Inputs
There are different inputs available for tests and test suites, as well as for Cloud and your own instance.
There are different inputs available for tests and test suites, as well as for Pro and your own instance.

### Test

Expand Down Expand Up @@ -134,14 +134,14 @@ There are different inputs available for tests and test suites, as well as for C
| ✗ | namespace | Set namespace to run test suite in.
```

### Cloud and Enterprise
### Pro and Enterprise

```sh
| Required | Name | Description
+----------+--------------+------------------------------------------------------------------------------------------------------------------------------
| ✓ | organization | The organization ID from Testkube Cloud or Enterprise - it starts with tkc_org, you may find it i.e. in the dashboard's URL.
| ✓ | environment | The environment ID from Testkube Cloud or Enterprise - it starts with tkc_env, you may find it i.e. in the dashboard's URL.
| ✓ | token | API token that has at least a permission to run specific test or test suite. Read more about creating API token in Testkube Cloud or Enterprise.
| ✓ | organization | The organization ID from Testkube Pro or Enterprise - it starts with tkc_org, you may find it i.e. in the dashboard's URL.
| ✓ | environment | The environment ID from Testkube Pro or Enterprise - it starts with tkc_env, you may find it i.e. in the dashboard's URL.
| ✓ | token | API token that has at least a permission to run specific test or test suite. Read more about creating API token in Testkube Pro or Enterprise.
| ✗ | url | URL of the Testkube Enterprise instance, if applicable.
| ✗ | dashboardUrl | URL of the Testkube Enterprise dashboard, if applicable, to display links for the execution.
```
Expand Down
6 changes: 3 additions & 3 deletions docs/docs/articles/testkube-oss.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Welcome to the Open Source version of Testkube!

Designed to integrate seamlessly with your Kubernetes clusters, Testkube offers flexibility and power. For those searching for a quicker and streamlined experience, we suggest [signing up for Testkube Cloud](https://cloud.testkube.io/). However, for organizations that prefer the hands-on approach, diving deep into the [Open Source](testkube-oss.md) version could be the ideal choice.
Designed to integrate seamlessly with your Kubernetes clusters, Testkube offers flexibility and power. For those searching for a quicker and streamlined experience, we suggest [signing up for Testkube Pro](https://app.testkube.io/). However, for organizations that prefer the hands-on approach, diving deep into the [Open Source](testkube-oss.md) version could be the ideal choice.

Visit [Open Source or Cloud](open-source-or-cloud.md) to see a comparison of features to help you with your choice.
Visit [Open Source or Pro](open-source-or-pro.md) to see a comparison of features to help you with your choice.

Also, take a look at our [Quick Setup Video](https://www.youtube.com/watch?v=ynzEkOUhxKk).

Expand Down Expand Up @@ -32,5 +32,5 @@ This command will set up the following components in your Kubernetes cluster:
Verify Your Installation: Ensure that Testkube is up and running with:
`kubectl get all -n testkube`.

Once set up, you're ready to unleash the full potential of Testkube in your environment. Whether you opt for the Open Source or Cloud variant, Testkube is committed to powering your development and testing workflows seamlessly.
Once set up, you're ready to unleash the full potential of Testkube in your environment. Whether you opt for the Open Source or Pro variant, Testkube is committed to powering your development and testing workflows seamlessly.

Loading

0 comments on commit 4881e02

Please sign in to comment.