docs: Migrate Web Images to Local Images (#3853)

* Migrate Web Images to Local Images In the Testkube Cloud doc pages. * Update architecture.md * Update environment-management.md * Update installing-agent.md * Update organization-management.md * Update managing-cli-context.md
kubeshop · May 18, 2023 · 4416fa0 · 4416fa0
1 parent a5448d2
commit 4416fa0
Show file tree

Hide file tree

Showing 33 changed files with 98 additions and 101 deletions.
diff --git a/docs/docs/img/adding-new-member.png b/docs/docs/img/adding-new-member.png
diff --git a/docs/docs/img/admin-roles.png b/docs/docs/img/admin-roles.png
diff --git a/docs/docs/img/admin-token.png b/docs/docs/img/admin-token.png
diff --git a/docs/docs/img/copy-helm-command.png b/docs/docs/img/copy-helm-command.png
diff --git a/docs/docs/img/creating-environment.jpeg b/docs/docs/img/creating-environment.jpeg
diff --git a/docs/docs/img/delete-org.png b/docs/docs/img/delete-org.png
diff --git a/docs/docs/img/env-drop-down.png b/docs/docs/img/env-drop-down.png
diff --git a/docs/docs/img/env-information.png b/docs/docs/img/env-information.png
diff --git a/docs/docs/img/env-settings.png b/docs/docs/img/env-settings.png
diff --git a/docs/docs/img/environment-role.png b/docs/docs/img/environment-role.png
diff --git a/docs/docs/img/existing-environments.png b/docs/docs/img/existing-environments.png
diff --git a/docs/docs/img/fill-in-env-name.png b/docs/docs/img/fill-in-env-name.png
diff --git a/docs/docs/img/free-plan.png b/docs/docs/img/free-plan.png
diff --git a/docs/docs/img/install-steps-2.png b/docs/docs/img/install-steps-2.png
diff --git a/docs/docs/img/install-steps.png b/docs/docs/img/install-steps.png
diff --git a/docs/docs/img/manage-subscriptions.png b/docs/docs/img/manage-subscriptions.png
diff --git a/docs/docs/img/member-role.png b/docs/docs/img/member-role.png
diff --git a/docs/docs/img/multiple-clusters.jpeg b/docs/docs/img/multiple-clusters.jpeg
diff --git a/docs/docs/img/network.jpeg b/docs/docs/img/network.jpeg
diff --git a/docs/docs/img/org-members.png b/docs/docs/img/org-members.png
diff --git a/docs/docs/img/org-settings.png b/docs/docs/img/org-settings.png
diff --git a/docs/docs/img/pass-info.png b/docs/docs/img/pass-info.png
diff --git a/docs/docs/img/pro-plan-billing.png b/docs/docs/img/pro-plan-billing.png
diff --git a/docs/docs/img/roles-for-token.png b/docs/docs/img/roles-for-token.png
diff --git a/docs/docs/img/setting-context.png b/docs/docs/img/setting-context.png
diff --git a/docs/docs/img/validate-install.png b/docs/docs/img/validate-install.png
diff --git a/docs/docs/testkube-cloud/articles/architecture.md b/docs/docs/testkube-cloud/articles/architecture.md
@@ -5,8 +5,7 @@
 The main Testkube Cloud feature is to have insights into multiple Testkube Cloud Agents. 
 You can look at your Kubernetes clusters from a single dashboard and easily switch between different Testkube clusters. 
 
-
-![multiple clusters](https://user-images.githubusercontent.com/30776/208391158-a42d1f56-950f-48c3-bcfb-2768054b4704.jpeg)
+![multiple clusters](../../img/multiple-clusters.jpeg)
 
 
 ## Storing Results
@@ -24,8 +23,7 @@ This allows Testkube Cloud to send commands which Testkube will manage in Agent
 After installation, the Testkube Agent connects to Testkube Cloud and starts listening for commands. 
 Additionally the Agent is connecting to the Testkube Cloud REST API.
 
-
-![network](https://user-images.githubusercontent.com/30776/208391192-6f04ce7a-2c8a-4892-bc01-3a3b04cd3ddc.jpeg)
+![network](../../img/network.jpeg)
 
 Testkube Agent is connecting to `https://api.testkube.io` on port `8088` for HTTPS connection and on port `8089` for GRPC connection.  
 
diff --git a/docs/docs/testkube-cloud/articles/environment-management.md b/docs/docs/testkube-cloud/articles/environment-management.md
@@ -1,47 +1,47 @@
-# Environment management
+# Environment Management
 
-Environment in Testkube is related to the Testkube agent, who is responsible for sending
-test insight to Testkube Cloud, and for managing your Kubernetes related cluster resources.
+Environment in Testkube is related to the Testkube agent, which is responsible for sending
+test insights to Testkube Cloud and for managing your Kubernetes related cluster resources.
 
 
-## Creating new environment
+## Creating a New Environment
 
-You can create new environment from "Environments" drop down in header section of Testkube Cloud UI. 
+You can create a new environment from the "Environments" drop down in the header section of the Testkube Cloud UI. 
 
-![env-drop-down](https://user-images.githubusercontent.com/30776/230015851-eae48d9e-e634-4771-be2f-6d28e42bb55b.png)
+![env-drop-down](../../img/env-drop-down.png)
 
-Fro installation instruction follow [Testkube Agent Installation](installing-agent.md)
+For installation instructions, follow [Testkube Agent Installation](installing-agent.md)
 
-## Changing environment settings
+## Changing Environment Settings
 
-![env-settings](https://user-images.githubusercontent.com/30776/230016969-a38e0915-ae4b-426a-a844-bb646ed85bdc.png)
+![env-settings](../../img/env-settings.png)
 
 
-On "General" tab you can see environment informatio like
+On the "General" tab, you can see environment information:
 * Connection state 
 * Agent name
-* Agent version - In case of new Testkube Agent version available you'll be noticed here to upgrade
-* Testkube CLI context command - to configure your testkube CLI with cloud context
+* Agent version - If a new Testkube Agent version is available, you'll be prompted to upgrade.
+* Testkube CLI context command - To configure your Testkube CLI with cloud context.
 
-You can also delete given environment (be careful this action can't be rolled-back!)
+You can also delete a given environment (be careful, this action can't be rolled-back!)
 
-![env-settings](https://user-images.githubusercontent.com/30776/230017592-160a0a5e-370f-4efe-9317-daedfad364b3.png)
+![env-information](../../img/env-information.png)
 
 
-## Managing environment members
+## Managing Environment Member Roles
 
-Keep in mind that all organiazation `admin` users can access all environments.
+Keep in mind that all organization `admin` users can access all environments.
 
-To add new organization user with member role use "Members" tab.
+To add new organization users with member role use the "Members" tab.
 
-![adding-new-menmber](https://user-images.githubusercontent.com/30776/230018272-50507361-12eb-47ea-8649-015392b69eea.png)
+![adding-new-member](../../img/adding-new-member.png)
 
-You can choose one from the roles for user: 
+You can choose from one of the following roles for a user: 
 
-* `Read`: Has read access only to all entities in an environment, test results, artifacts, logs, etc...
-* `Run`: Has Read + Can trigger Test/suite executions.
-* `Write`: Has Run + Can make changes to environment tests, triggers, webhooks, etc...
-* `Admin`: Has write + is allowed to invite and change other collaborator roles.
+* `Read`: Has Read access only to all entities in an environment, test results, artifacts, logs, etc...
+* `Run`: Has Read access and can trigger Test/ Test Suite 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.
 
 
 

diff --git a/docs/docs/testkube-cloud/articles/installing-agent.md b/docs/docs/testkube-cloud/articles/installing-agent.md
@@ -2,42 +2,42 @@
 
 ## Installation Steps
 
-1. To add a new agent, create a new environment in: 
+1. To add a new agent, create a new environment: 
 
-![creating-environment](https://user-images.githubusercontent.com/30776/207018935-2e1c9d27-2e84-42f2-89c7-faa81ac6eabd.jpg)
+![Create Environment](../../img/creating-environment.jpeg)
 
+![Pass Info](../../img/pass-info.png)
 
-![Pass info](https://user-images.githubusercontent.com/30776/206459262-7e8e5987-f30a-41a5-aada-02a58bfc8b31.png)
 
 2. Fill in the environment name: 
 
-![Fill in env name](https://user-images.githubusercontent.com/30776/206459469-ceb3dd3d-0eb5-48ca-89be-6debc807b5d3.png)
+![Fill in Env Name](../../img/fill-in-env-name.png)
 
 3. Copy the Helm install command into the terminal to install a new Testkube environment in Agent mode: 
 
-![Copy helm command](https://user-images.githubusercontent.com/30776/206459486-8c7a50a0-4c7c-43f0-ae6a-5a84941f3613.png)
+![Copy Helm Command](../../img/copy-helm-command.png)
 
 4. Run the command in your terminal.
 
 You will need *Helm* installed and `kubectl` configured with access to your Kubernetes cluster: 
-- To install `helm` just follow [install instrcutions on Helm web site](https://helm.sh/docs/intro/install/)
-- To install `kubectl` follow [Kubernetes docs](https://kubernetes.io/docs/tasks/tools/)
+- To install `helm` just follow the [install instrcutions on the Helm web site](https://helm.sh/docs/intro/install/).
+- To install `kubectl` follow [Kubernetes docs](https://kubernetes.io/docs/tasks/tools/).
 
-![install-steps 1](https://user-images.githubusercontent.com/30776/229802501-69a76f00-8e56-41de-b3d5-8315b6902cc2.png)
+![Install Steps 1](../../img/install-steps.png)
 
-5. After some time, you should see Helm installation notice: 
+5. After some time, you should see the Helm installation notice: 
 
-![Install steps 2](https://user-images.githubusercontent.com/30776/206460312-86211dd2-dc50-48be-b33b-11f07720df0a.png)
+![Install Steps 2](../../img/install-steps-2.png)
 
 
 ## Validating the Installation 
 
 Testkube Cloud will notify if the installation is successful. 
 
-* A green indicator means that your cluster was able to connect to Testkube Cloud.
+* 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).
 
-![Validate install](https://user-images.githubusercontent.com/30776/206461244-f885c270-fc57-4919-9330-89a1ce5ad082.png)
+![Validate Install](../../img/validate-install.png)
 
 In case of a RED status you can try to debug the issues with the command below:
 

diff --git a/docs/docs/testkube-cloud/articles/intro.md b/docs/docs/testkube-cloud/articles/intro.md
@@ -1,17 +1,17 @@
 # Testkube Cloud
 
 Testkube Cloud is the managed version of Testkube with the main purpose of:
-- Orchestrating tests throughout multiple clusters 
-- Managing different environments for testing (development, staging, production, etc.) 
-- Enabling enterprise authentication and RBAC
-- Simplifying test artifacts storage
+- Orchestrating tests throughout multiple clusters. 
+- Managing different environments for testing (development, staging, production, etc.). 
+- Enabling enterprise authentication and RBAC.
+- Simplifying test artifacts storage.
 
-## How it works? 
+## How does it work? 
 
-The way Testkube Cloud works is by installing adding an agent to the Testkube installation in your cluster, which then connects with Testkube's servers. This allows Testkube to offer these added functionalities while you can still benefit from Testkube's main feature of running your testing tools inside your cluster. 
+The way Testkube Cloud works is by installing and adding an agent to the Testkube installation in your cluster, which then connects with Testkube's servers. This allows Testkube to offer these added functionalities while you can still benefit from Testkube's main feature of running your testing tools inside your cluster. 
 
-## Getting started 
+## Getting Started 
 
 You can start using Testkube Cloud by either: 
-- [**Migrating Testkube Open Source**](./transition-from-oss.md) your existing Testkube Open Source instance to a Cloud instance
-- Creating a fresh installation, using [cloud.testkube.io](https://cloud.testkube.io)
+- [**Migrating Testkube Open Source**](./transition-from-oss.md) from your existing Testkube Open Source instance to a Cloud instance.
+- Creating a fresh installation, using [cloud.testkube.io](https://cloud.testkube.io).
diff --git a/docs/docs/testkube-cloud/articles/managing-cli-context.md b/docs/docs/testkube-cloud/articles/managing-cli-context.md
@@ -6,20 +6,20 @@ The token you create can have different roles associated with it for fine-graine
 
 * **Admin** access rights (access to all environments):
 
-![admin-token](https://user-images.githubusercontent.com/30776/229772185-01f1e466-b04d-4c6d-9d5c-e4464d651177.png)
+![Admin Token](../../img/admin-token.png)
 
-* Specific role for given environments:
+* Specific role for selected environments:
 
-![roles-for-token](https://user-images.githubusercontent.com/30776/229772310-64bda85d-57a8-47b7-a68b-2625089724f8.png)
+![Roles for Token](../../img/roles-for-token.png)
 
 
+When the token is created, you're ready to change the Testkube CLI context: 
 
-When your token is there, you're ready to change the Testkube CLI context: 
+![Setting Context](../../img/setting-context.png)
 
-![setting-context](https://user-images.githubusercontent.com/30776/229771159-4415aa74-70bb-4684-9511-449d0779b483.png)
 
 
-# Connecting using `kubeconfig` context
+# Connecting Using `kubeconfig` Context
 
 If you want to connect to your Testkube instance directly (like you would do with `kubectl`), set the CLI Context to be `kubeconfig`-based: 
 

diff --git a/docs/docs/testkube-cloud/articles/organization-management.md b/docs/docs/testkube-cloud/articles/organization-management.md
@@ -1,116 +1,115 @@
-# Organizations management
+# Organizations Management
 
 
-To manage your organization settings click "Manage Organization" from organizations drop-down menu
+To manage your organization settings click "Manage Organization" from organizations drop-down menu:
 
-![image](https://user-images.githubusercontent.com/30776/230005688-f88ae2f2-5570-4b25-80e5-ae524a384437.png)
+![Organization Settings](../../img/org-settings.png)
 
-You can also create new organiztion. 
+You can also create new organization. 
 
 
-## Organization settings
+## Organization Settings
 
-To edit your organization settings click one from the available options from menu on the left
+To edit your organization settings, click an organization from the available options from menu on the left.
 
 ### Environments
 
-In environments section you can see list of your existing environments. 
+In the environments section you can see the list of your existing environments.
 
-![image](https://user-images.githubusercontent.com/30776/230006228-70275cca-1365-4d04-8387-725cf87c448b.png)
+![Existing Environments](../../img/existing-environments.png)
 
-Green status colot mean that your agent is connected successfully. 
+GREEN status means that your agent is connected successfully. 
 
-In case of a RED status you can try to debug the issues with the command below:
+In the case of a RED status, you can try to debug the issues with the command below:
 
 ```sh
 testkube agent debug
 ```
 
-on your cluster where the given agent is installed
+Run this on your cluster where the given agent is installed.
 
 
 
 ### Settings
 
-In settings you can remove your organiztion. Keep in mind that this operation can't be rolled-back! 
-
-![image](https://user-images.githubusercontent.com/30776/230007193-6d6004c1-57b3-4ea5-9c36-68aa4933ca57.png)
+In settings you can remove your organiztion. Keep in mind that this operation can't be rolled-back!
 
+![Delete Organization](../../img/delete-org.png)
 
 
 ### Members
 
-For each organization you can define who can access it and what kind on actions given member can do. 
+For each organization you can define who has access and what kind of actions each member can use. 
 
-![organiation-members](https://user-images.githubusercontent.com/30776/230007820-afbd49b1-b918-42ad-80de-a4d59714c2e6.png)
+![Organization Members](../../img/org-members.png)
 
 
 There are 4 types of organization members: 
 
-* `owner` - has access to all environments and organization settings, also can access billing details
-* `admin` - has access to all environments and organization settings.
-* `biller` - has access to billing details only.
-* `member` - has limited access to environments, access is defined by the roles assigned to given member. Member by default doesn't have any access, you need to [explicitly set it in given environment](environment-management.md). 
+* `owner` - Has access to all environments and organization settings, also can access billing details.
+* `admin` - Has access to all environments and organization settings.
+* `biller` - Has access to billing details only.
+* `member` - Has limited access to environments, access is defined by the roles assigned to given member. Member by default doesn't have any access, you need to [explicitly set it in the given environment](environment-management.md). 
 
 
 
 ### API Tokens
 
-Sometimes you need machine-to-machine authorization to e.g. run tests in CI pipelines, or just call particular actions from your services. 
+Sometimes you need machine-to-machine authorization to run tests in CI pipelines or  call particular actions from your services. 
 Testkube offers API Tokens to resolve this issue. API Tokens have very similar roles like members. 
 
 Each token can have also expiration date, you can set it for given time period or as "No expiration" (not recommended for production environments).
-If token is not needed anymore yo ucan delete it from tokens list. 
+If token is not needed anymore you can delete it from the tokens list. 
 
 API Tokens can have 2 roles: 
 
-#### "admin" access to all environments
+#### "admin" - access to all environments
 
-![image](https://user-images.githubusercontent.com/30776/230009462-3dee4b99-3bf4-4b5c-986d-806077b33281.png)
+![Admin Role](../../img/admin-roles.png)
 
-#### "member" limited access to environments, either limited access for environment actions 
+#### "member" - limited access to environments or limited access for environment actions 
 
-![image](https://user-images.githubusercontent.com/30776/230010012-607b69da-24e8-4ec7-8888-f004759a1dd1.png)
+![Member Role](../../img/member-role.png)
 
-For member organization role you should choose which environments you want to add to the created API Token, additionally for each 
-environment roles should be choosen: 
+For the member organization role, you should choose which environments you want to add to the created API Token, additionally, role should be chosen for each 
+environment: 
 
-![image](https://user-images.githubusercontent.com/30776/230010190-cacd1798-794f-466e-ac5c-d68801d23ed0.png)
+![Environment Role](../../img/environment-role.png)
 
 We have 3 available roles for environment access: 
-* `Read` - read only, you can only call get and list endpoints which not mutate data in any way
-* `Run` - you can read and run - no changes to the environment.
-* `Write` - you can change environments and run tests. 
+* `Read` - Read only, you can only call get and list endpoints which not mutate data in any way.
+* `Run` - Access to Read and Run but no changes to the environment.
+* `Write` - You can change environments and run tests. 
 
 ### Usage & Billing
 
-#### Upgrading testkube to `PRO` plan
+#### Upgrading Testkube to the `PRO` Plan
 
-![Zrzut ekranu 2023-04-5 o 09 31 43](https://user-images.githubusercontent.com/30776/230012570-7c1a67c9-77a5-4c02-903a-9f0fa93c9279.png)
+![PRO Plan Billing](../../img/pro-plan-billing.png)
 
-#### `Free` plan usage 
+#### `Free` Plan Usage 
 
-All limits are calculated monthly. You have: 
+All limits are calculated monthly. On the 'Free' plan, you have: 
 - 600 executions 
 - 2 environments
 - 2GB artifacts storage
 - 3 Users
 
-![image](https://user-images.githubusercontent.com/30776/230013186-0f5c748d-58fb-4c9c-83df-5210c613ebaa.png)
+![Free Plan](../../img/free-plan.png)
 
 
 
-#### `PRO` plan usage
+#### `PRO` Plan Usage
 
-`PRO` plan doesn't have any limits, you need to subscribe it and you'll get: 
+Subscribing to the `PRO` plan provides: 
 - 5000 test executions
 - **Unlimited** environments
 - **128GB** of artifacts storage
 - **25** users
 
-If you need more - just use testkube - and you'll be charged for additional usage
-(For prices details follow your subscription details by clicking "Manage subscription" button) 
+If you need more - just use Testkube - and you'll be charged for additional usage.
+For pricing details, visit your subscription by clicking the "Manage subscription" button. 
 
-![image](https://user-images.githubusercontent.com/30776/230013404-444eda20-04e5-4422-99ff-bfb05b4424ba.png)
+![Manage Subcriptions](../../img/manage-subscriptions.png)
 
 
diff --git a/docs/docs/testkube-cloud/articles/transition-from-oss.md b/docs/docs/testkube-cloud/articles/transition-from-oss.md
@@ -1,13 +1,13 @@
 # Migrating from Testkube Open Source
 
-If you have started using Testkube using the Open Source installation, you can migrate this instace to be managed using Testkube Cloud. 
+If you have started using Testkube using the Open Source installation, you can migrate this instance to be managed using Testkube Cloud. 
 
-To connect your Testkube Open Source instance you will need to modify your Testkube installation to be in Cloud Agent mode. Testkube Cloud Agent is the Testkube engine for controlling your Testkube instance using the managed solution. It sends data to Testkube's Cloud Servers.
+To connect your Testkube Open Source instance, you will need to modify your Testkube installation to be in Cloud Agent mode. Testkube Cloud Agent is the Testkube engine for controlling your Testkube instance using the managed solution. It sends data to Testkube's Cloud Servers.
 
 ::: note
 
-Currently we are supporting uploading existing test logs and artifacts from your Testkube Open Source instance. This is planned for coming releases.
-s
+Currently, we do not support uploading existing test logs and artifacts from your Testkube Open Source instance. This is planned for coming releases.
+
 ::: 
 
 ## Instructions
@@ -18,4 +18,4 @@ s
 testkube cloud connect
 ```
 
-2. [Set your CLI Context to talk to Testkube Cloud](./managing-cli-context.md)
+2. [Set your CLI Context to talk to Testkube Cloud](./managing-cli-context.md).