Environment Management
What is an Environment?
A Testkube Environment is a grouping of Workflows, Workflow Templates, Triggers and Webhooks - and their corresponding artifacts, logs, and execution results.
You can create multiple environments within your Testkube Organization (see below) to organize your resources and usage of Testkube accordingly, for example, you can create a separate environment for each of your development teams (although if you are looking for a way to control access to Resources, Resource Groups might be a better approach).
A Testkube Environment can contain any number of Testkube Agents, which are responsible for managing Resources, executing Workflows and listening to Events.
At the technical level, the Resources in a Testkube environment are managed by a Testkube Agent running in your Kubernetes Cluster - read more here.
Your existing Environments are available from the Environment dropdown on the top of the Testkube Dashboard (see screenshot below), selecting an Environment will focus the Testkube Dashboard on the resources in that Environment - Read More.
Creating a New Environment
You can create a new environment from the Environments dropdown in the header section of the Testkube Dashboard:
You can create an Environment from the "Environments" panel in the Organization Settings also.
Cloud Options
When creating a new environment in the Testkube Cloud Control Plane, you will first be prompted with the following options:
- I have a K8s Cluster - select this if you have a cluster where you can install the Testkube Agent for your environment.
- No Cluster at hand - setting up a local cluster for evaluation purposes is straightforward, for example using kind or minikube. Alternatively, you can use our sandbox environment for exploring Testkube functionality with having to install anything.
- I don't use Kubernetes - if you're not familiar with Kubernetes and don't want to install a local cluster, you can use our sandbox environment for exploring Testkube functionality with having to install anything.
Testkube Sandbox Environment
The Testkube Sandbox environment available in the Testkube Cloud Control Plane is a great way to explore the functionality provided by Testkube. It contains a large collection of Workflows for different testing tools, with corresponding execution results and Test Insights.
You are added as a member with the Run role (see below), which gives you read-only access to explore and run these workflows and their results, as well as read-only access to all other major features of Testkube.
Environment name
Creating an environment in Testkube on-prem or selecting Let's get started in the cloud-specific dialog above will show a prompt for a unique environment name:
Environment connection
After providing the environment name you will be prompted as shown below to Install the CLI (do this only if you haven't already done so) and then run a CLI command to install the Testkube Agent for your environment, the provided command will automatically connect the Agent to your Control Plane.
Running the provided Testkube CLI command in your terminal will install the agent and connect it to the created environment:
Once connected, you should see a corresponding status update in the dialog above to indicate that the installation was successful.
Environment Settings
You can access the settings for an existing Environment either from the same top-level menu or the corresponding toolbar buttton on the left:
There are 6 panels for managing your Environment.
General
Find the general settings for your environment on the General tab. You can also delete the environment here, but, be aware, this action cannot be undone.
Agents
Manage your Environment Agents here - Read More.
Environment Members
You can assign environment-specific roles to Teams or individual Members of your organization to control which actions a member can perform in a specific environment.
Adding Environment Members
To add new members to an Environment, select the Members tab under the Environment settings and use the "Add Collaborators" section to search for and add individual members or teams from your organization.
You can choose from one of the following roles for a member:
Read: Has Read access only to all entities in an environment, test results, artifacts, logs, etc...Run: Has Read access and can trigger executions.Write: Has Run access and can make changes to environment tests, triggers, webhooks, etc...Admin: Has Write access and is allowed to invite and change other collaborator roles.
Keep in mind that all organization admin users can always access all environments.
Have a look at Resource Access Management to get an overview of how Testkube allows you to manage and apply Resource Access controls.
Listing Environment Members
You can see a list of existing Environment members at the bottom of this panel, and change their role or remove them using the popup menu on the right:
Keyword Handling
This tab allows you to manage the Filtering categories available for Log Highlighting
There are 4 default categories, represented with a few keywords each:
| Category | Keywords |
|---|---|
| Error Keywords | Error, Exception, Fail, Critical, Fatal |
| Connection | Connection, Disconnect, Lost, Timeout, Refused, Handshake, Retrying |
| Resource Issues | OutOfMemory, MemoryLeak, ResourceExhausted, LimitExceeded, Quota |
| Access & Authorization | Denied, Unauthorized, Forbidden, Invalid, Invalid Token, Expired |
You can add/edit/remove categories using the corresponding actions in the interface.
Queueing & Concurrency
This panel allows you to configure the Queueing & Concurrency settings for your Environment
- Environment Queue Limit / Max Queued Executions: Immediately abort new executions when the number of queued executions for this environment surpasses the given threshold.
- Runner Concurrency Limit / Max Concurrent Executions: Queue this execution when ongoing executions when all runners surpasses the given threshold.
Check out Concurrency & Queueing to learn more about this functionality.
Product Features
This tab allows you to configure Environment-level Product Features:
