diff --git a/docs/docs/articles/crds-reference.md b/docs/docs/articles/crds-reference.md index 89359d4a105..240edd0e684 100644 --- a/docs/docs/articles/crds-reference.md +++ b/docs/docs/articles/crds-reference.md @@ -11,7 +11,7 @@ CRDs (Custom Resource Definitions) reference. Read more Testkube's CRDs in [Test ## executor.testkube.io/v1 -Package v1 contains API Schema definitions for the executor v1 API group +Package v1 contains API Schema definitions for the executor v1 API group. ### Resource Types @@ -30,7 +30,7 @@ _Appears in:_ #### Executor -Executor is the Schema for the executors API +Executor is the Schema for the executors API. _Appears in:_ @@ -45,7 +45,7 @@ _Appears in:_ #### ExecutorList -ExecutorList contains a list of Executor +ExecutorList contains a list of Executors. | Field | Description | | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | @@ -56,7 +56,7 @@ ExecutorList contains a list of Executor #### ExecutorMeta -Executor meta data +Executor meta data. _Appears in:_ @@ -70,7 +70,7 @@ _Appears in:_ #### ExecutorSpec -ExecutorSpec defines the desired state of Executor +ExecutorSpec defines the desired state of the Executor. _Appears in:_ @@ -78,17 +78,17 @@ _Appears in:_ | Field | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `types` _string array_ | Types defines what types can be handled by executor e.g. "postman/collection", ":curl/command" etc | -| `executor_type` _[ExecutorType](#executortype)_ | ExecutorType one of "rest" for rest openapi based executors or "job" which will be default runners for testkube or "container" for container executors | -| `uri` _string_ | URI for rest based executors | -| `image` _string_ | Image for kube-job | -| `args` _string array_ | executor binary arguments | -| `command` _string array_ | executor default binary command | -| `imagePullSecrets` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core) array_ | container executor default image pull secrets | -| `features` _[Feature](#feature) array_ | Features list of possible features which executor handles | -| `content_types` _[ScriptContentType](#scriptcontenttype) array_ | ContentTypes list of handled content types | -| `job_template` _string_ | Job template to launch executor | -| `meta` _[ExecutorMeta](#executormeta)_ | Meta data about executor | +| `types` _string array_ | Types defines what types can be handled by executor e.g. "postman/collection", ":curl/command", etc. | +| `executor_type` _[ExecutorType](#executortype)_ | ExecutorType one of "rest" for rest openapi based executors or "job" which will be default runners for testkube or "container" for container executors. | +| `uri` _string_ | URI for rest-based executors. | +| `image` _string_ | Image for kube-job. | +| `args` _string array_ | Executor binary arguments. | +| `command` _string array_ | Executor default binary command. | +| `imagePullSecrets` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core) array_ | Container executor default image pull secrets. | +| `features` _[Feature](#feature) array_ | Features list of Possible features which the executor handles. | +| `content_types` _[ScriptContentType](#scriptcontenttype) array_ | ContentTypes lists the handled content types. | +| `job_template` _string_ | Job template to launch executor. | +| `meta` _[ExecutorMeta](#executormeta)_ | Meta data about the executor. | #### ExecutorType @@ -116,7 +116,7 @@ _Appears in:_ #### Webhook -Webhook is the Schema for the webhooks API +Webhook is the Schema for the webhooks API. _Appears in:_ @@ -131,7 +131,7 @@ _Appears in:_ #### WebhookList -WebhookList contains a list of Webhook +WebhookList contains a list of Webhooks. | Field | Description | | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | @@ -142,7 +142,7 @@ WebhookList contains a list of Webhook #### WebhookSpec -WebhookSpec defines the desired state of Webhook +WebhookSpec defines the desired state of a Webhook. _Appears in:_ @@ -150,16 +150,16 @@ _Appears in:_ | Field | Description | | ----------------------------------------------- | ------------------------------------------------------------------ | -| `uri` _string_ | Uri is address where webhook should be made | -| `events` _[EventType](#eventtype) array_ | Events declare list if events on which webhook should be called | -| `selector` _string_ | Labels to filter for tests and test suites | -| `payloadObjectField` _string_ | will load the generated payload for notification inside the object | -| `payloadTemplate` _string_ | golang based template for notification payload | -| `headers` _object (keys:string, values:string)_ | webhook headers | +| `uri` _string_ | The URI is the address where the webhook should be made. | +| `events` _[EventType](#eventtype) array_ | Events declares a list of events on which webhook should be called. | +| `selector` _string_ | Labels to filter for tests and test suites. | +| `payloadObjectField` _string_ | Will load the generated payload for notification inside the object. | +| `payloadTemplate` _string_ | Golang based template for notification payload. | +| `headers` _object (keys:string, values:string)_ | Webhook headers. | ## tests.testkube.io/v1 -Package v1 contains API Schema definitions for the testkube v1 API group +Package v1 contains API Schema definitions for the testkube v1 API group. ### Resource Types @@ -178,7 +178,7 @@ Package v1 contains API Schema definitions for the testkube v1 API group _Underlying type:_ `string` -GitAuthType defines git auth type +GitAuthType defines git auth type. _Appears in:_ @@ -186,7 +186,7 @@ _Appears in:_ #### Repository -Repository represents VCS repo, currently we're handling Git only +Repository represents VCS repo, currently we're handling Git only. _Appears in:_ @@ -194,20 +194,20 @@ _Appears in:_ | Field | Description | | ------------------------------------------ | ---------------------------------------------------------------------------------------- | -| `type` _string_ | VCS repository type | -| `uri` _string_ | uri of content file or git directory | -| `branch` _string_ | branch/tag name for checkout | -| `commit` _string_ | commit id (sha) for checkout | -| `path` _string_ | if needed we can checkout particular path (dir or file) in case of BIG/mono repositories | +| `type` _string_ | VCS repository type. | +| `uri` _string_ | URI of content file or Git directory. | +| `branch` _string_ | Branch/tag name for checkout. | +| `commit` _string_ | Commit id (sha) for checkout. | +| `path` _string_ | If needed, we can checkout a particular path (dir or file) in case of BIG/mono repositories. | | `usernameSecret` _[SecretRef](#secretref)_ | | | `tokenSecret` _[SecretRef](#secretref)_ | | -| `certificateSecret` _string_ | git auth certificate secret for private repositories | -| `workingDir` _string_ | if provided we checkout the whole repository and run test from this directory | -| `authType` _[GitAuthType](#gitauthtype)_ | auth type for git requests | +| `certificateSecret` _string_ | Git auth certificate, secret for private repositories. | +| `workingDir` _string_ | If provided, we checkout the whole repository and run the test from this directory. | +| `authType` _[GitAuthType](#gitauthtype)_ | Auth type for Git requests. | #### Script -Script is the Schema for the scripts API +Script is the Schema for the scripts API. _Appears in:_ @@ -222,7 +222,7 @@ _Appears in:_ #### ScriptList -ScriptList contains a list of Script +ScriptList contains a list of scripts. | Field | Description | | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | @@ -233,7 +233,7 @@ ScriptList contains a list of Script #### ScriptSpec -ScriptSpec defines the desired state of Script +ScriptSpec defines the desired state of a script. _Appears in:_ @@ -241,17 +241,17 @@ _Appears in:_ | Field | Description | | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `type` _string_ | script type | -| `name` _string_ | script execution custom name | -| `params` _object (keys:string, values:string)_ | execution params passed to executor | -| `content` _string_ | script content as string (content depends from executor) | -| `input-type` _string_ | script content type can be: - direct content - created from file, - git repo directory checkout in case when test is some kind of project or have more than one file, | -| `repository` _[Repository](#repository)_ | repository details if exists | +| `type` _string_ | Script type. | +| `name` _string_ | Script execution custom name. | +| `params` _object (keys:string, values:string)_ | Execution params passed to executor. | +| `content` _string_ | Script content as string (content depends on the executor). | +| `input-type` _string_ | Script content type can be: (1) direct content - created from file, (2) Git repo directory checkout, in case the test is some kind of project or has more than one file. | +| `repository` _[Repository](#repository)_ | Repository details, if they exist. | | `tags` _string array_ | | #### SecretRef -Testkube internal reference for secret storage in Kubernetes secrets +Testkube internal reference for secret storage in Kubernetes secrets. _Appears in:_ @@ -265,7 +265,7 @@ _Appears in:_ #### Test -Test is the Schema for the tests API +Test is the Schema for the tests API. _Appears in:_ @@ -280,7 +280,7 @@ _Appears in:_ #### TestList -TestList contains a list of Test +TestList contains a list of Tests. | Field | Description | | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | @@ -291,7 +291,7 @@ TestList contains a list of Test #### TestSource -TestSource is the Schema for the testsources API +TestSource is the the Schema for the testsources API. _Appears in:_ @@ -306,7 +306,7 @@ _Appears in:_ #### TestSourceList -TestSourceList contains a list of TestSource +TestSourceList contains a list of TestSources. | Field | Description | | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | @@ -317,7 +317,7 @@ TestSourceList contains a list of TestSource #### TestSourceSpec -TestSourceSpec defines the desired state of TestSource +TestSourceSpec defines the desired state of TestSource. _Appears in:_ @@ -340,7 +340,7 @@ _Appears in:_ #### TestSpec -TestSpec defines the desired state of Test +TestSpec defines the desired state of the Test. _Appears in:_ @@ -348,9 +348,9 @@ _Appears in:_ | Field | Description | | ---------------------------------------------- | ----------------------------------------------------------------------- | -| `before` _[TestStepSpec](#teststepspec) array_ | Before steps is list of scripts which will be sequentially orchestrated | -| `steps` _[TestStepSpec](#teststepspec) array_ | Steps is list of scripts which will be sequentially orchestrated | -| `after` _[TestStepSpec](#teststepspec) array_ | After steps is list of scripts which will be sequentially orchestrated | +| `before` _[TestStepSpec](#teststepspec) array_ | Before steps is a list of scripts which will be sequentially orchestrated. | +| `steps` _[TestStepSpec](#teststepspec) array_ | Steps is a list of scripts which will be sequentially orchestrated. | +| `after` _[TestStepSpec](#teststepspec) array_ | After steps is a list of scripts which will be sequentially orchestrated. | | `repeats` _integer_ | | | `description` _string_ | | | `tags` _string array_ | | @@ -379,7 +379,7 @@ _Appears in:_ #### TestStepSpec -TestStepSpec will of particular type will have config for possible step types +TestStepSpec of particular type will have config for possible step types. _Appears in:_ @@ -393,7 +393,7 @@ _Appears in:_ #### TestSuite -TestSuite is the Schema for the testsuites API +TestSuite is the Schema for the testsuites API. _Appears in:_ @@ -408,7 +408,7 @@ _Appears in:_ #### TestSuiteList -TestSuiteList contains a list of TestSuite +TestSuiteList contains a list of TestSuites. | Field | Description | | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | @@ -419,7 +419,7 @@ TestSuiteList contains a list of TestSuite #### TestSuiteSpec -TestSuiteSpec defines the desired state of TestSuite +TestSuiteSpec defines the desired state of a TestSuite. _Appears in:_ @@ -427,18 +427,18 @@ _Appears in:_ | Field | Description | | ---------------------------------------------------------------- | --------------------------------------------------------------------- | -| `before` _[TestSuiteStepSpec](#testsuitestepspec) array_ | Before steps is list of tests which will be sequentially orchestrated | -| `steps` _[TestSuiteStepSpec](#testsuitestepspec) array_ | Steps is list of tests which will be sequentially orchestrated | -| `after` _[TestSuiteStepSpec](#testsuitestepspec) array_ | After steps is list of tests which will be sequentially orchestrated | +| `before` _[TestSuiteStepSpec](#testsuitestepspec) array_ | Before steps is a list of tests which will be sequentially orchestrated. | +| `steps` _[TestSuiteStepSpec](#testsuitestepspec) array_ | Steps is a list of tests which will be sequentially orchestrated. | +| `after` _[TestSuiteStepSpec](#testsuitestepspec) array_ | After steps is a list of tests which will be sequentially orchestrated. | | `repeats` _integer_ | | | `description` _string_ | | -| `schedule` _string_ | schedule in cron job format for scheduled test execution | -| `params` _object (keys:string, values:string)_ | DEPRECATED execution params passed to executor | -| `variables` _object (keys:string, values:[Variable](#variable))_ | Variables are new params with secrets attached | +| `schedule` _string_ | Schedule in cron job format for scheduled test execution. | +| `params` _object (keys:string, values:string)_ | DEPRECATED execution params passed to the executor. | +| `variables` _object (keys:string, values:[Variable](#variable))_ | Variables are new params with secrets attached. | #### TestSuiteStepDelay -TestSuiteStepDelay contains step delay parameters +TestSuiteStepDelay contains step delay parameters. _Appears in:_ @@ -450,7 +450,7 @@ _Appears in:_ #### TestSuiteStepExecute -TestSuiteStepExecute defines step to be executed +TestSuiteStepExecute defines the step to be executed. _Appears in:_ @@ -464,7 +464,7 @@ _Appears in:_ #### TestSuiteStepSpec -TestSuiteStepSpec will of particular type will have config for possible step types +TestSuiteStepSpec of a particular type will have config for possible step types. _Appears in:_ @@ -478,7 +478,7 @@ _Appears in:_ #### TestTrigger -TestTrigger is the Schema for the testtriggers API +TestTrigger is the Schema for the testtriggers API. _Appears in:_ @@ -495,7 +495,7 @@ _Appears in:_ _Underlying type:_ `string` -TestTriggerAction defines action for test triggers +TestTriggerAction defines action for test triggers. _Appears in:_ @@ -503,7 +503,7 @@ _Appears in:_ #### TestTriggerCondition -TestTriggerCondition is used for definition of the condition for test triggers +TestTriggerCondition is used for definition of the condition for test triggers. _Appears in:_ @@ -511,13 +511,13 @@ _Appears in:_ | Field | Description | | ----------------- | ----------------------------------------------------------------------------------- | -| `type` _string_ | test trigger condition | -| `reason` _string_ | test trigger condition reason | -| `ttl` _integer_ | duration in seconds in the past from current time when the condition is still valid | +| `type` _string_ | Test trigger condition. | +| `reason` _string_ | Test trigger condition reason. | +| `ttl` _integer_ | Duration in seconds in the past from current time when the condition is still valid. | #### TestTriggerConditionSpec -TestTriggerConditionSpec defines the condition specification for TestTrigger +TestTriggerConditionSpec defines the condition specification for the TestTrigger. _Appears in:_ @@ -525,14 +525,14 @@ _Appears in:_ | Field | Description | | ------------------------------------------------------------------ | ---------------------------------------------------------------------------- | -| `conditions` _[TestTriggerCondition](#testtriggercondition) array_ | list of test trigger conditions | -| `timeout` _integer_ | duration in seconds the test trigger waits for conditions, until its stopped | +| `conditions` _[TestTriggerCondition](#testtriggercondition) array_ | List of test trigger conditions. | +| `timeout` _integer_ | Duration in seconds the test trigger waits for conditions, until it is stopped. | #### TestTriggerEvent _Underlying type:_ `string` -TestTriggerEvent defines event for test triggers +TestTriggerEvent defines an event for test triggers. _Appears in:_ @@ -542,7 +542,7 @@ _Appears in:_ _Underlying type:_ `string` -TestTriggerExecution defines execution for test triggers +TestTriggerExecution defines execution for test triggers. _Appears in:_ @@ -550,7 +550,7 @@ _Appears in:_ #### TestTriggerList -TestTriggerList contains a list of TestTrigger +TestTriggerList contains a list of TestTriggers. | Field | Description | | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | @@ -563,7 +563,7 @@ TestTriggerList contains a list of TestTrigger _Underlying type:_ `string` -TestTriggerResource defines resource for test triggers +TestTriggerResource defines the resource for test triggers. _Appears in:_ @@ -571,7 +571,7 @@ _Appears in:_ #### TestTriggerSelector -TestTriggerSelector is used for selecting Kubernetes Objects +TestTriggerSelector is used for selecting Kubernetes Objects. _Appears in:_ @@ -579,13 +579,13 @@ _Appears in:_ | Field | Description | | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | -| `name` _string_ | Name selector is used to identify a Kubernetes Object based on the metadata name | -| `namespace` _string_ | Namespace of the Kubernetes object | -| `labelSelector` _[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#labelselector-v1-meta)_ | LabelSelector is used to identify a group of Kubernetes Objects based on their metadata labels | +| `name` _string_ | Name selector is used to identify a Kubernetes Object based on the metadata name. | +| `namespace` _string_ | Namespace of the Kubernetes object. | +| `labelSelector` _[LabelSelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#labelselector-v1-meta)_ | LabelSelector is used to identify a group of Kubernetes Objects based on their metadata labels. | #### TestTriggerSpec -TestTriggerSpec defines the desired state of TestTrigger +TestTriggerSpec defines the desired state of a TestTrigger. _Appears in:_ @@ -593,14 +593,14 @@ _Appears in:_ | Field | Description | | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| `resource` _[TestTriggerResource](#testtriggerresource)_ | For which Resource do we monitor Event which triggers an Action on certain conditions | -| `resourceSelector` _[TestTriggerSelector](#testtriggerselector)_ | ResourceSelector identifies which Kubernetes Objects should be watched | -| `event` _[TestTriggerEvent](#testtriggerevent)_ | On which Event for a Resource should an Action be triggered | -| `conditionSpec` _[TestTriggerConditionSpec](#testtriggerconditionspec)_ | What resource conditions should be matched | -| `action` _[TestTriggerAction](#testtriggeraction)_ | Action represents what needs to be executed for selected Execution | -| `execution` _[TestTriggerExecution](#testtriggerexecution)_ | Execution identifies for which test execution should an Action be executed | -| `testSelector` _[TestTriggerSelector](#testtriggerselector)_ | TestSelector identifies on which Testkube Kubernetes Objects an Action should be taken | -| `delay` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#duration-v1-meta)_ | Delay is a duration string which specifies how long should the test be delayed after a trigger is matched | +| `resource` _[TestTriggerResource](#testtriggerresource)_ | Defines the Resource monitor Event which triggers an Action on certain conditions. | +| `resourceSelector` _[TestTriggerSelector](#testtriggerselector)_ | ResourceSelector identifies which Kubernetes Objects should be watched. | +| `event` _[TestTriggerEvent](#testtriggerevent)_ | Defines the Event on which a Resource an Action should be triggered. | +| `conditionSpec` _[TestTriggerConditionSpec](#testtriggerconditionspec)_ | Which resource conditions should be matched. | +| `action` _[TestTriggerAction](#testtriggeraction)_ | Action represents what needs to be executed for a selected Execution. | +| `execution` _[TestTriggerExecution](#testtriggerexecution)_ | Execution identifies which test execution an Action should be executed for. | +| `testSelector` _[TestTriggerSelector](#testtriggerselector)_ | TestSelector identifies on which Testkube Kubernetes Objects an Action should be taken. | +| `delay` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#duration-v1-meta)_ | Delay is a duration string which specifies how long the test should be delayed after a trigger is matched. | #### Variable @@ -616,11 +616,11 @@ _Appears in:_ | `type` _string_ | variable type | | `name` _string_ | variable name | | `value` _string_ | variable string value | -| `valueFrom` _[EnvVarSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#envvarsource-v1-core)_ | or load it from var source | +| `valueFrom` _[EnvVarSource](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#envvarsource-v1-core)_ | Load variable from var source. | ## tests.testkube.io/v2 -Package v2 contains API Schema definitions for the testkube v2 API group +Package v2 contains API Schema definitions for the Testkube v2 API group. ### Resource Types @@ -633,7 +633,7 @@ Package v2 contains API Schema definitions for the testkube v2 API group #### Repository -Repository represents VCS repo, currently we're handling Git only +Repository represents the VCS repo, currently we're handling Git only. _Appears in:_ @@ -641,17 +641,17 @@ _Appears in:_ | Field | Description | | ------------------- | ---------------------------------------------------------------------------------------- | -| `type` _string_ | VCS repository type | -| `uri` _string_ | uri of content file or git directory | -| `branch` _string_ | branch/tag name for checkout | -| `commit` _string_ | commit id (sha) for checkout | -| `path` _string_ | if needed we can checkout particular path (dir or file) in case of BIG/mono repositories | -| `username` _string_ | git auth username for private repositories | -| `token` _string_ | git auth token for private repositories | +| `type` _string_ | VCS repository type. | +| `uri` _string_ | URI of content file or Git directory. | +| `branch` _string_ | Branch/tag name for checkout. | +| `commit` _string_ | Commit ID (sha) for checkout. | +| `path` _string_ | If needed, we can checkout a particular path (dir or file) in case of BIG/mono repositories. | +| `username` _string_ | Git auth username for private repositories. | +| `token` _string_ | Git auth token for private repositories. | #### RunningContext -running context for test or test suite execution +Running context for test or test suite execution. _Appears in:_ @@ -659,8 +659,8 @@ _Appears in:_ | Field | Description | | -------------------------------------------------- | ------------------------------------- | -| `type` _[RunningContextType](#runningcontexttype)_ | One of possible context types | -| `context` _string_ | Context value depending from its type | +| `type` _[RunningContextType](#runningcontexttype)_ | One of possible context types. | +| `context` _string_ | Context value depending from its type. | #### RunningContextType @@ -672,7 +672,7 @@ _Appears in:_ #### Script -Script is the Schema for the scripts API +Script is the Schema for the scripts API. _Appears in:_ @@ -696,11 +696,11 @@ _Appears in:_ | `type` _string_ | script type | | `repository` _[Repository](#repository)_ | repository of script content | | `data` _string_ | script content body | -| `uri` _string_ | uri of script content | +| `uri` _string_ | URI of script content | #### ScriptList -ScriptList contains a list of Script +ScriptList contains a list of Scripts. | Field | Description | | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | @@ -711,7 +711,7 @@ ScriptList contains a list of Script #### ScriptSpec -ScriptSpec defines the desired state of Script +ScriptSpec defines the desired state of a Script. _Appears in:_ @@ -727,7 +727,7 @@ _Appears in:_ #### Test -Test is the Schema for the tests API +Test is the Schema for the tests API. _Appears in:_ @@ -742,7 +742,7 @@ _Appears in:_ #### TestContent -TestContent defines test content +TestContent defines the test content. _Appears in:_ @@ -757,7 +757,7 @@ _Appears in:_ #### TestList -TestList contains a list of Test +TestList contains a list of Tests. | Field | Description | | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | @@ -768,7 +768,7 @@ TestList contains a list of Test #### TestSpec -TestSpec defines the desired state of Test +TestSpec defines the desired state of a Test. _Appears in:_ @@ -778,15 +778,15 @@ _Appears in:_ | ---------------------------------------------------------------- | -------------------------------------------------------- | | `type` _string_ | test type | | `name` _string_ | test execution custom name | -| `params` _object (keys:string, values:string)_ | DEPRECATED execution params passed to executor | -| `variables` _object (keys:string, values:[Variable](#variable))_ | Variables are new params with secrets attached | +| `params` _object (keys:string, values:string)_ | DEPRECATED execution params passed to executor. | +| `variables` _object (keys:string, values:[Variable](#variable))_ | Variables are new params with secrets attached. | | `content` _[TestContent](#testcontent)_ | test content object | -| `schedule` _string_ | schedule in cron job format for scheduled test execution | -| `executorArgs` _string array_ | additional executor binary arguments | +| `schedule` _string_ | Schedule in cron job format for scheduled test execution. | +| `executorArgs` _string array_ | Additional executor binary arguments. | #### TestSuite -TestSuite is the Schema for the testsuites API +TestSuite is the Schema for the testsuites API. _Appears in:_ @@ -801,7 +801,7 @@ _Appears in:_ #### TestSuiteExecutionCore -test suite execution core +The test suite execution core. _Appears in:_ @@ -809,13 +809,13 @@ _Appears in:_ | Field | Description | | ------------------------------------------------------------------------------------------------------- | ------------------------------- | -| `id` _string_ | execution id | +| `id` _string_ | execution ID | | `startTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#time-v1-meta)_ | test suite execution start time | | `endTime` _[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#time-v1-meta)_ | test suite execution end time | #### TestSuiteExecutionRequest -test suite execution request body +The test suite execution request body. _Appears in:_ @@ -823,22 +823,22 @@ _Appears in:_ | Field | Description | | ---------------------------------------------------------------- | ----------------------------------------------------- | -| `name` _string_ | test execution custom name | -| `namespace` _string_ | test kubernetes namespace (\"testkube\" when not set) | +| `name` _string_ | The test execution custom name. | +| `namespace` _string_ | The test Kubernetes namespace (\"testkube\" when not set). | | `variables` _object (keys:string, values:[Variable](#variable))_ | | -| `secretUUID` _string_ | secret uuid | +| `secretUUID` _string_ | secret UUID | | `labels` _object (keys:string, values:string)_ | test suite labels | | `executionLabels` _object (keys:string, values:string)_ | execution labels | -| `sync` _boolean_ | whether to start execution sync or async | -| `httpProxy` _string_ | http proxy for executor containers | -| `httpsProxy` _string_ | https proxy for executor containers | -| `timeout` _integer_ | timeout for test suite execution | +| `sync` _boolean_ | Whether to start execution sync or async. | +| `httpProxy` _string_ | HTTP proxy for executor containers | +| `httpsProxy` _string_ | HTTPS proxy for executor containers | +| `timeout` _integer_ | Timeout for test suite execution. | | `runningContext` _[RunningContext](#runningcontext)_ | | -| `cronJobTemplate` _string_ | cron job template extensions | +| `cronJobTemplate` _string_ | Cron job template extensions. | #### TestSuiteList -TestSuiteList contains a list of TestSuite +TestSuiteList contains a list of TestSuites. | Field | Description | | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | @@ -849,7 +849,7 @@ TestSuiteList contains a list of TestSuite #### TestSuiteSpec -TestSuiteSpec defines the desired state of TestSuite +TestSuiteSpec defines the desired state of a TestSuite. _Appears in:_ @@ -857,17 +857,17 @@ _Appears in:_ | Field | Description | | ---------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `before` _[TestSuiteStepSpec](#testsuitestepspec) array_ | Before steps is list of tests which will be sequentially orchestrated | -| `steps` _[TestSuiteStepSpec](#testsuitestepspec) array_ | Steps is list of tests which will be sequentially orchestrated | -| `after` _[TestSuiteStepSpec](#testsuitestepspec) array_ | After steps is list of tests which will be sequentially orchestrated | +| `before` _[TestSuiteStepSpec](#testsuitestepspec) array_ | Before steps is a list of tests which will be sequentially orchestrated. | +| `steps` _[TestSuiteStepSpec](#testsuitestepspec) array_ | Steps is a list of tests which will be sequentially orchestrated. | +| `after` _[TestSuiteStepSpec](#testsuitestepspec) array_ | After steps is a list of tests which will be sequentially orchestrated. | | `repeats` _integer_ | | | `description` _string_ | | -| `schedule` _string_ | schedule in cron job format for scheduled test execution | +| `schedule` _string_ | Schedule in cron job format for scheduled test execution. | | `executionRequest` _[TestSuiteExecutionRequest](#testsuiteexecutionrequest)_ | | #### TestSuiteStepDelay -TestSuiteStepDelay contains step delay parameters +TestSuiteStepDelay contains step delay parameters. _Appears in:_ @@ -879,7 +879,7 @@ _Appears in:_ #### TestSuiteStepExecute -TestSuiteStepExecute defines step to be executed +TestSuiteStepExecute defines the step to be executed. _Appears in:_ @@ -893,7 +893,7 @@ _Appears in:_ #### TestSuiteStepSpec -TestSuiteStepSpec for particular type will have config for possible step types +TestSuiteStepSpec for a particular type will have the config for possible step types. _Appears in:_ @@ -909,7 +909,7 @@ _Appears in:_ _Underlying type:_ `string` -TestSuiteStepType defines different type of test suite steps +TestSuiteStepType defines different types of test suite steps. _Appears in:_ @@ -933,7 +933,7 @@ _Appears in:_ ## tests.testkube.io/v3 -Package v3 contains API Schema definitions for the tests v3 API group +Package v3 contains API Schema definitions for the tests v3 API group. ### Resource Types @@ -944,7 +944,7 @@ Package v3 contains API Schema definitions for the tests v3 API group _Underlying type:_ `string` -ArgsModeType defines args mode type +ArgsModeType defines the args mode type. _Appears in:_ @@ -952,7 +952,7 @@ _Appears in:_ #### ArtifactRequest -artifact request body with test artifacts +Artifact request body with test artifacts. _Appears in:_ @@ -960,13 +960,13 @@ _Appears in:_ | Field | Description | | --------------------------- | -------------------------------------------------- | -| `storageClassName` _string_ | artifact storage class name for container executor | -| `volumeMountPath` _string_ | artifact volume mount path for container executor | -| `dirs` _string array_ | artifact directories for scraping | +| `storageClassName` _string_ | The artifact storage class name for the container executor. | +| `volumeMountPath` _string_ | The artifact volume mount path for the container executor. | +| `dirs` _string array_ | The artifact directories for scraping. | #### EnvReference -Reference to env resource +Reference to env resource. _Appears in:_ @@ -975,13 +975,13 @@ _Appears in:_ | Field | Description | | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | | `reference` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core)_ | | -| `mount` _boolean_ | whether we shoud mount resource | -| `mountPath` _string_ | where we shoud mount resource | -| `mapToVariables` _boolean_ | whether we shoud map to variables from resource | +| `mount` _boolean_ | Whether we should mount a resource. | +| `mountPath` _string_ | Where we should mount resource. | +| `mapToVariables` _boolean_ | Whether we should map to variables from a resource. | #### ExecutionCore -test execution core +The test execution core. _Appears in:_ @@ -996,7 +996,7 @@ _Appears in:_ #### ExecutionRequest -test execution request body +The test execution request body. _Appears in:_ @@ -1004,32 +1004,32 @@ _Appears in:_ | Field | Description | | ---------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `name` _string_ | test execution custom name | -| `testSuiteName` _string_ | unique test suite name (CRD Test suite name), if it's run as a part of test suite | -| `number` _integer_ | test execution number | -| `executionLabels` _object (keys:string, values:string)_ | test execution labels | -| `namespace` _string_ | test kubernetes namespace (\"testkube\" when not set) | -| `variablesFile` _string_ | variables file content - need to be in format for particular executor (e.g. postman envs file) | +| `name` _string_ | The test execution custom name. | +| `testSuiteName` _string_ | The unique test suite name (CRD Test suite name), if it's run as a part of a test suite. | +| `number` _integer_ | The test execution number. | +| `executionLabels` _object (keys:string, values:string)_ | The test execution labels. | +| `namespace` _string_ | The test Kubernetes namespace (\"testkube\" when not set). | +| `variablesFile` _string_ | Variables file content - needs to be in the format for a particular executor (e.g. postman envs file). | | `isVariablesFileUploaded` _boolean_ | | | `variables` _object (keys:string, values:[Variable](#variable))_ | | -| `testSecretUUID` _string_ | test secret uuid | -| `testSuiteSecretUUID` _string_ | test suite secret uuid, if it's run as a part of test suite | -| `args` _string array_ | additional executor binary arguments | -| `argsMode` _[ArgsModeType](#argsmodetype)_ | usage mode for arguments | -| `command` _string array_ | executor binary command | -| `image` _string_ | container executor image | -| `imagePullSecrets` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core) array_ | container executor image pull secrets | -| `envs` _object (keys:string, values:string)_ | Environment variables passed to executor. Deprecated: use Basic Variables instead | -| `secretEnvs` _object (keys:string, values:string)_ | Execution variables passed to executor from secrets. Deprecated: use Secret Variables instead | -| `sync` _boolean_ | whether to start execution sync or async | -| `httpProxy` _string_ | http proxy for executor containers | -| `httpsProxy` _string_ | https proxy for executor containers | -| `negativeTest` _boolean_ | negative test will fail the execution if it is a success and it will succeed if it is a failure | +| `testSecretUUID` _string_ | test secret UUID | +| `testSuiteSecretUUID` _string_ | The test suite secret uuid, if it's run as a part of a test suite. | +| `args` _string array_ | Additional executor binary arguments. | +| `argsMode` _[ArgsModeType](#argsmodetype)_ | Usage mode for arguments. | +| `command` _string array_ | Executor binary command. | +| `image` _string_ | Container executor image. | +| `imagePullSecrets` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.22/#localobjectreference-v1-core) array_ | Container executor image pull secrets. | +| `envs` _object (keys:string, values:string)_ | Environment variables passed to executor. Deprecated: use Basic Variables instead. | +| `secretEnvs` _object (keys:string, values:string)_ | Execution variables passed to executor from secrets. Deprecated: use Secret Variables instead. | +| `sync` _boolean_ | Whether to start execution sync or async. | +| `httpProxy` _string_ | HTTP proxy for executor containers. | +| `httpsProxy` _string_ | HTTPS proxy for executor containers. | +| `negativeTest` _boolean_ | A negative test will fail the execution if it is a success and it will succeed if it is a failure. | | `activeDeadlineSeconds` _integer_ | Optional duration in seconds the pod may be active on the node relative to StartTime before the system will actively try to mark it failed and kill associated containers. Value must be a positive integer. | | `artifactRequest` _[ArtifactRequest](#artifactrequest)_ | | | `jobTemplate` _string_ | job template extensions | | `cronJobTemplate` _string_ | cron job template extensions | -| `preRunScript` _string_ | script to run before test execution | +| `preRunScript` _string_ | The script to run before test execution. | | `scraperTemplate` _string_ | scraper template extensions | | `envConfigMaps` _[EnvReference](#envreference) array_ | config map references | | `envSecrets` _[EnvReference](#envreference) array_ | secret references | @@ -1039,7 +1039,7 @@ _Appears in:_ _Underlying type:_ `string` -GitAuthType defines git auth type +GitAuthType defines the Git auth type. _Appears in:_ @@ -1047,7 +1047,7 @@ _Appears in:_ #### Repository -Repository represents VCS repo, currently we're handling Git only +Repository represents VCS repo, currently we're handling Git only. _Appears in:_ @@ -1056,19 +1056,19 @@ _Appears in:_ | Field | Description | | ------------------------------------------ | ---------------------------------------------------------------------------------------- | | `type` _string_ | VCS repository type | -| `uri` _string_ | uri of content file or git directory | +| `uri` _string_ | URI of content file or Git directory | | `branch` _string_ | branch/tag name for checkout | | `commit` _string_ | commit id (sha) for checkout | -| `path` _string_ | if needed we can checkout particular path (dir or file) in case of BIG/mono repositories | +| `path` _string_ | If needed, we can checkout a particular path (dir or file) in the case of BIG/mono repositories. | | `usernameSecret` _[SecretRef](#secretref)_ | | | `tokenSecret` _[SecretRef](#secretref)_ | | -| `certificateSecret` _string_ | git auth certificate secret for private repositories | -| `workingDir` _string_ | if provided we checkout the whole repository and run test from this directory | +| `certificateSecret` _string_ | Git auth certificate secret for private repositories | +| `workingDir` _string_ | If provided, we check out the whole repository and run the test from this directory. | | `authType` _[GitAuthType](#gitauthtype)_ | auth type for git requests | #### RunningContext -running context for test or test suite execution +The Running context for test or test suite execution. _Appears in:_ @@ -1089,7 +1089,7 @@ _Appears in:_ #### SecretRef -Testkube internal reference for secret storage in Kubernetes secrets +Testkube internal reference for secret storage in Kubernetes secrets. _Appears in:_ @@ -1103,7 +1103,7 @@ _Appears in:_ #### Test -Test is the Schema for the tests API +Test is the Schema for the tests API. _Appears in:_ @@ -1118,7 +1118,7 @@ _Appears in:_ #### TestContent -TestContent defines test content +TestContent defines test content. _Appears in:_ @@ -1141,7 +1141,7 @@ _Appears in:_ #### TestList -TestList contains a list of Test +TestList contains a list of the Test. | Field | Description | | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | @@ -1152,7 +1152,7 @@ TestList contains a list of Test #### TestSpec -TestSpec defines the desired state of Test +TestSpec defines the the desired state of a Test. _Appears in:_ diff --git a/docs/docs/articles/deploying-from-private-registries.md b/docs/docs/articles/deploying-from-private-registries.md index 0e1765c824c..9ba2afe010f 100644 --- a/docs/docs/articles/deploying-from-private-registries.md +++ b/docs/docs/articles/deploying-from-private-registries.md @@ -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. diff --git a/docs/docs/articles/getting-started.md b/docs/docs/articles/getting-started.md index 276cc54ebbf..4233a666900 100644 --- a/docs/docs/articles/getting-started.md +++ b/docs/docs/articles/getting-started.md @@ -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. - + -## 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) @@ -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) diff --git a/docs/docs/articles/github-actions.md b/docs/docs/articles/github-actions.md index ebc0e6b723f..e7e14a9b2ae 100644 --- a/docs/docs/articles/github-actions.md +++ b/docs/docs/articles/github-actions.md @@ -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 . -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: @@ -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: @@ -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 @@ -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; @@ -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. diff --git a/docs/docs/articles/gitlab.md b/docs/docs/articles/gitlab.md index 5c869de0cac..02dd3dc272c 100644 --- a/docs/docs/articles/gitlab.md +++ b/docs/docs/articles/gitlab.md @@ -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`. diff --git a/docs/docs/articles/jenkins.md b/docs/docs/articles/jenkins.md index dd74d5d41fb..19ef0723a7b 100644 --- a/docs/docs/articles/jenkins.md +++ b/docs/docs/articles/jenkins.md @@ -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`. diff --git a/docs/docs/articles/open-source-or-cloud.md b/docs/docs/articles/open-source-or-pro.md similarity index 58% rename from docs/docs/articles/open-source-or-cloud.md rename to docs/docs/articles/open-source-or-pro.md index dd0241a7311..f8ca64d6056 100644 --- a/docs/docs/articles/open-source-or-cloud.md +++ b/docs/docs/articles/open-source-or-pro.md @@ -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 | \ No newline at end of file diff --git a/docs/docs/articles/run-tests-with-github-actions.md b/docs/docs/articles/run-tests-with-github-actions.md index c8eaf30a91b..eccde46c9af 100644 --- a/docs/docs/articles/run-tests-with-github-actions.md +++ b/docs/docs/articles/run-tests-with-github-actions.md @@ -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: @@ -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 @@ -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. ``` diff --git a/docs/docs/articles/testkube-oss.md b/docs/docs/articles/testkube-oss.md index e62311027ad..a934aab386e 100644 --- a/docs/docs/articles/testkube-oss.md +++ b/docs/docs/articles/testkube-oss.md @@ -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). @@ -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. diff --git a/docs/docs/cli/testkube.md b/docs/docs/cli/testkube.md index b65faeba20b..c9509530834 100644 --- a/docs/docs/cli/testkube.md +++ b/docs/docs/cli/testkube.md @@ -1,6 +1,6 @@ ## testkube -Testkube entrypoint for kubectl plugin +Testkube entrypoint for kubectl plugin. ``` testkube [flags] @@ -20,8 +20,8 @@ testkube [flags] ### SEE ALSO * [testkube abort](testkube_abort.md) - Abort tests or test suites -* [testkube agent](testkube_agent.md) - Testkube Cloud Agent related commands -* [testkube cloud](testkube_cloud.md) - Testkube Cloud commands +* [testkube agent](testkube_agent.md) - Testkube Pro Agent related commands +* [testkube pro](testkube_pro.md) - Testkube Pro commands * [testkube completion](testkube_completion.md) - Generate the autocompletion script for the specified shell * [testkube config](testkube_config.md) - Set feature configuration value * [testkube create](testkube_create.md) - Create resource @@ -35,7 +35,7 @@ testkube [flags] * [testkube generate](testkube_generate.md) - Generate resources commands * [testkube get](testkube_get.md) - Get resources * [testkube init](testkube_init.md) - Install Helm chart registry in current kubectl context and update dependencies -* [testkube login](testkube_login.md) - Login to Testkube Cloud +* [testkube login](testkube_login.md) - Login to Testkube Pro * [testkube migrate](testkube_migrate.md) - manual migrate command * [testkube purge](testkube_purge.md) - Uninstall Helm chart registry from current kubectl context * [testkube run](testkube_run.md) - Runs tests or test suites diff --git a/docs/docs/cli/testkube_agent.md b/docs/docs/cli/testkube_agent.md index bf1f3c1ed7c..77a6cf4a9d9 100644 --- a/docs/docs/cli/testkube_agent.md +++ b/docs/docs/cli/testkube_agent.md @@ -1,6 +1,6 @@ ## testkube agent -Testkube Cloud Agent related commands +Testkube Pro Agent related commands ``` testkube agent [flags] diff --git a/docs/docs/cli/testkube_agent_debug.md b/docs/docs/cli/testkube_agent_debug.md index d66d8c4206c..d37e65f5d08 100644 --- a/docs/docs/cli/testkube_agent_debug.md +++ b/docs/docs/cli/testkube_agent_debug.md @@ -24,5 +24,5 @@ testkube agent debug [flags] ### SEE ALSO -* [testkube agent](testkube_agent.md) - Testkube Cloud Agent related commands +* [testkube agent](testkube_agent.md) - Testkube Pro Agent related commands diff --git a/docs/docs/cli/testkube_cloud.md b/docs/docs/cli/testkube_cloud.md deleted file mode 100644 index 5d2ce9660bb..00000000000 --- a/docs/docs/cli/testkube_cloud.md +++ /dev/null @@ -1,32 +0,0 @@ -## testkube cloud - -Testkube Cloud commands - -``` -testkube cloud [flags] -``` - -### Options - -``` - -h, --help help for cloud -``` - -### Options inherited from parent commands - -``` - -a, --api-uri string api uri, default value read from config if set (default "https://demo.testkube.io/results/v1") - -c, --client string client used for connecting to Testkube API one of proxy|direct (default "proxy") - --namespace string Kubernetes namespace, default value read from config if set (default "testkube") - --oauth-enabled enable oauth - --verbose show additional debug messages -``` - -### SEE ALSO - -* [testkube](testkube.md) - Testkube entrypoint for kubectl plugin -* [testkube cloud connect](testkube_cloud_connect.md) - Testkube Cloud connect -* [testkube cloud disconnect](testkube_cloud_disconnect.md) - Switch back to Testkube OSS mode, based on active .kube/config file -* [testkube cloud init](testkube_cloud_init.md) - Install Testkube Cloud Agent and connect to Testkube Cloud environment -* [testkube cloud login](testkube_cloud_login.md) - Login to Testkube Cloud - diff --git a/docs/docs/cli/testkube_login.md b/docs/docs/cli/testkube_login.md index 906cd008d15..47ef2aac903 100644 --- a/docs/docs/cli/testkube_login.md +++ b/docs/docs/cli/testkube_login.md @@ -1,6 +1,6 @@ ## testkube login -Login to Testkube Cloud +Login to Testkube Pro ``` testkube login [flags] @@ -9,10 +9,10 @@ testkube login [flags] ### Options ``` - --cloud-root-domain string defaults to testkube.io, usually don't need to be changed [required for cloud mode] (default "testkube.io") - --env-id string Testkube Cloud environment id + --pro-root-domain string defaults to testkube.io, usually don't need to be changed [required for pro mode] (default "testkube.io") + --env-id string Testkube Pro environment id -h, --help help for login - --org-id string Testkube Cloud organization id + --org-id string Testkube Pro organization id ``` ### Options inherited from parent commands diff --git a/docs/docs/cli/testkube_pro.md b/docs/docs/cli/testkube_pro.md new file mode 100644 index 00000000000..049667c5789 --- /dev/null +++ b/docs/docs/cli/testkube_pro.md @@ -0,0 +1,32 @@ +## testkube pro + +Testkube Pro commands + +``` +testkube pro [flags] +``` + +### Options + +``` + -h, --help help for pro +``` + +### Options inherited from parent commands + +``` + -a, --api-uri string api uri, default value read from config if set (default "https://app.testkube.io/results/v1") + -c, --client string client used for connecting to Testkube API one of proxy|direct (default "proxy") + --namespace string Kubernetes namespace, default value read from config if set (default "testkube") + --oauth-enabled enable oauth + --verbose show additional debug messages +``` + +### SEE ALSO + +* [testkube](testkube.md) - Testkube entrypoint for kubectl plugin +* [testkube pro connect](testkube_pro_connect.md) - Testkube Pro connect +* [testkube pro disconnect](testkube_pro_disconnect.md) - Switch back to Testkube OSS mode, based on active .kube/config file +* [testkube pro init](testkube_pro_init.md) - Install Testkube Pro Agent and connect to Testkube Pro environment +* [testkube pro login](testkube_pro_login.md) - Login to Testkube Pro + diff --git a/docs/docs/cli/testkube_cloud_connect.md b/docs/docs/cli/testkube_pro_connect.md similarity index 70% rename from docs/docs/cli/testkube_cloud_connect.md rename to docs/docs/cli/testkube_pro_connect.md index 074c2411b9f..3811097ba26 100644 --- a/docs/docs/cli/testkube_cloud_connect.md +++ b/docs/docs/cli/testkube_pro_connect.md @@ -1,20 +1,20 @@ -## testkube cloud connect +## testkube pro connect -Testkube Cloud connect +Testkube Pro connect ``` -testkube cloud connect [flags] +testkube pro connect [flags] ``` ### Options ``` - --agent-token string Testkube Cloud agent key [required for cloud mode] + --agent-token string Testkube Pro agent key [required for pro mode] --chart string chart name (usually you don't need to change it) (default "kubeshop/testkube") - --cloud-root-domain string defaults to testkube.io, usually don't need to be changed [required for cloud mode] (default "testkube.io") + --pro-root-domain string defaults to testkube.io, usually don't need to be changed [required for pro mode] (default "testkube.io") --dashboard-replicas int Dashboard replicas --dry-run dry run mode - only print commands that would be executed - --env-id string Testkube Cloud environment id [required for cloud mode] + --env-id string Testkube Pro environment id [required for pro mode] -h, --help help for connect --minio-replicas int MinIO replicas --mongo-replicas int MongoDB replicas @@ -24,7 +24,7 @@ testkube cloud connect [flags] --no-dashboard don't install dashboard --no-minio don't install MinIO --no-mongo don't install MongoDB - --org-id string Testkube Cloud organization id [required for cloud mode] + --org-id string Testkube Pro organization id [required for pro mode] --values string path to Helm values file ``` @@ -39,5 +39,5 @@ testkube cloud connect [flags] ### SEE ALSO -* [testkube cloud](testkube_cloud.md) - Testkube Cloud commands +* [testkube pro](testkube_pro.md) - Testkube Pro commands diff --git a/docs/docs/cli/testkube_cloud_disconnect.md b/docs/docs/cli/testkube_pro_disconnect.md similarity index 91% rename from docs/docs/cli/testkube_cloud_disconnect.md rename to docs/docs/cli/testkube_pro_disconnect.md index 4dd5f888747..6edbfb28e2c 100644 --- a/docs/docs/cli/testkube_cloud_disconnect.md +++ b/docs/docs/cli/testkube_pro_disconnect.md @@ -1,9 +1,9 @@ -## testkube cloud disconnect +## testkube pro disconnect Switch back to Testkube OSS mode, based on active .kube/config file ``` -testkube cloud disconnect [flags] +testkube pro disconnect [flags] ``` ### Options @@ -35,5 +35,5 @@ testkube cloud disconnect [flags] ### SEE ALSO -* [testkube cloud](testkube_cloud.md) - Testkube Cloud commands +* [testkube pro](testkube_pro.md) - Testkube Pro commands diff --git a/docs/docs/cli/testkube_cloud_init.md b/docs/docs/cli/testkube_pro_init.md similarity index 69% rename from docs/docs/cli/testkube_cloud_init.md rename to docs/docs/cli/testkube_pro_init.md index a637a476b14..33df60e5fbb 100644 --- a/docs/docs/cli/testkube_cloud_init.md +++ b/docs/docs/cli/testkube_pro_init.md @@ -1,26 +1,26 @@ -## testkube cloud init +## testkube pro init -Install Testkube Cloud Agent and connect to Testkube Cloud environment +Install Testkube Pro Agent and connect to Testkube Pro environment ``` -testkube cloud init [flags] +testkube pro init [flags] ``` ### Options ``` - --agent-token string Testkube Cloud agent key + --agent-token string Testkube Pro agent key --chart string chart name (usually you don't need to change it) (default "kubeshop/testkube") - --cloud-root-domain string defaults to testkube.io, usually don't need to be changed [required for cloud mode] (default "testkube.io") + --pro-root-domain string defaults to testkube.io, usually don't need to be changed [required for pro mode] (default "testkube.io") --dry-run dry run mode - only print commands that would be executed - --env-id string Testkube Cloud environment id + --env-id string Testkube Pro environment id -h, --help help for init --multi-namespace multi namespace mode --name string installation name (usually you don't need to change it) (default "testkube") --namespace string namespace where to install (default "testkube") --no-confirm don't ask for confirmation - unatended installation mode --no-operator should operator be installed (for more instances in multi namespace mode it should be set to true) - --org-id string Testkube Cloud organization id + --org-id string Testkube Pro organization id --values string path to Helm values file ``` @@ -35,5 +35,5 @@ testkube cloud init [flags] ### SEE ALSO -* [testkube cloud](testkube_cloud.md) - Testkube Cloud commands +* [testkube pro](testkube_pro.md) - Testkube Pro commands diff --git a/docs/docs/cli/testkube_cloud_login.md b/docs/docs/cli/testkube_pro_login.md similarity index 58% rename from docs/docs/cli/testkube_cloud_login.md rename to docs/docs/cli/testkube_pro_login.md index fe6df5bab90..9b80a7714df 100644 --- a/docs/docs/cli/testkube_cloud_login.md +++ b/docs/docs/cli/testkube_pro_login.md @@ -1,18 +1,18 @@ -## testkube cloud login +## testkube pro login -Login to Testkube Cloud +Login to Testkube Pro ``` -testkube cloud login [flags] +testkube pro login [flags] ``` ### Options ``` - --cloud-root-domain string defaults to testkube.io, usually don't need to be changed [required for cloud mode] (default "testkube.io") - --env-id string Testkube Cloud environment id + --pro-root-domain string defaults to testkube.io, usually don't need to be changed [required for pro mode] (default "testkube.io") + --env-id string Testkube Pro environment id -h, --help help for login - --org-id string Testkube Cloud organization id + --org-id string Testkube Pro organization id ``` ### Options inherited from parent commands @@ -27,5 +27,5 @@ testkube cloud login [flags] ### SEE ALSO -* [testkube cloud](testkube_cloud.md) - Testkube Cloud commands +* [testkube pro](testkube_pro.md) - Testkube Pro commands diff --git a/docs/docs/conferences/testkube-plushy.md b/docs/docs/conferences/testkube-plushy.md index 92b396360d9..2b11412c3b8 100644 --- a/docs/docs/conferences/testkube-plushy.md +++ b/docs/docs/conferences/testkube-plushy.md @@ -12,7 +12,7 @@ Read on to learn how you can win a Testkube plushy! ## Instructions -Create a simple test using Testkube Cloud to win a Testkube plushy. +Create a simple test using Testkube Pro to win a Testkube plushy. You can follow these instructions or get help from our booth staff to create your first test with Testkube! @@ -32,9 +32,9 @@ kubectl create deployment hello-world --image=kubeshop/kusk-hello-world:v1.0.0 kubectl expose deployment hello-world --name hello-world-svc --port=8080 ``` -### 3. Sign in to Testkube Cloud +### 3. Sign in to Testkube Pro -Go to https://cloud.testkube.io/ and create an account on Testkube Cloud using your Github credentials. +Go to https://app.testkube.io/ and create an account on Testkube Pro using your Github credentials. ### 4. Install Testkube on your cluster @@ -52,7 +52,7 @@ Install Testkube in your K8s cluster: Let's create a quick `curl` test, but this can be any testing tool you're using like Postman, Cypress, K6, etc. -![Create test with Testkube Cloud](../img/conference-kubecon-create-test.png) +![Create test with Testkube Pro](../img/conference-kubecon-create-test.png) Use the following `curl` test that checks if the hello-world app returns a status `200`: diff --git a/docs/docs/test-types/executor-pytest.mdx b/docs/docs/test-types/executor-pytest.mdx index e4066625fc6..abf661fb391 100644 --- a/docs/docs/test-types/executor-pytest.mdx +++ b/docs/docs/test-types/executor-pytest.mdx @@ -6,15 +6,15 @@ You can run pytest with Testkube to use it in your automated tests for your Kube ## Usage Before starting, please switch your current folder to /contrib/container/pytest -### Step 1 - Add the executor to Testkube +### Step 1 - Add the executor to Testkube. ```sh `kubectl apply -f container-executor-pytest.yaml` ``` -### Step 2 - Build the executor Docker image +### Step 2 - Build the executor Docker image. -Current Docker image is based on python 3.8.17 and a few basic modules, like pipenv, pytest and requests. +Current Docker image is based on Python 3.8.17 and a few basic modules, like pipenv, pytest and requests. Feel free to change the python version, install missing dependencies, etc. Docker image should be placed in your favourite docker image registry, like local Docker image registry for Minikube, Kind, etc or Cloud provider one. @@ -22,7 +22,7 @@ favourite docker image registry, like local Docker image registry for Minikube, docker build -t pytest-executor -f Dockerfile ``` -### Step 3 - Create a test +### Step 3 - Create a test. ```sh kubectl apply -f pytest_test.yaml diff --git a/docs/docs/testkube-cloud/articles/architecture.md b/docs/docs/testkube-cloud/articles/architecture.md deleted file mode 100644 index ee7c4294b69..00000000000 --- a/docs/docs/testkube-cloud/articles/architecture.md +++ /dev/null @@ -1,29 +0,0 @@ -# Testkube Cloud Architecture - -## Multiple Testkube Agents - -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](../../img/multiple-clusters.jpeg) - - -## Storing Results - -In Testkube standalone, all results are stored in the users cluster, so you need to be aware of MinIO and MongoDB. -Testkube Cloud makes it easy for you. All data is stored in the Testkube Cloud infrastructure so you don't need to worry about backups. - - -## Testkube Networking - -To simplify networking connections, the Testkube Agent is able to create a connection to Testkube Cloud clusters. The Agent is registering itself into -Testkube Cloud as a new environment. -This allows Testkube Cloud to send commands which Testkube will manage in Agent mode. The connection is established from Testkube Agent to Testkube Cloud. - -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](../../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/cached-results.md b/docs/docs/testkube-cloud/articles/cached-results.md deleted file mode 100644 index bed566a6cff..00000000000 --- a/docs/docs/testkube-cloud/articles/cached-results.md +++ /dev/null @@ -1,53 +0,0 @@ -# Cached Test & Test Suite Results - -export const ProBadge = () => { - return ( - -

PRO FEATURE

- - ); -} - - - -Testkube cached test results allows you to see and inspect test execution results even when your Testkube agent is offline. - -## Overview - -![offline-test](../../img/offline-list.png) - -Testkube Cloud uses test execution data stored in Cloud to allow you inspect past test executions. This feature also works when your agent is online, but the Testkube agent doesn't have the test definition available in Kubernetes. - -Cached test results appear with a read-only tag. These tests cannot be updated. If you want to get rid of old tests, you can go to the Test Settings page and click "Delete Test". - -![offline-test-suite](../../img/offline-test-suite.png) - -Similar to tests, Testkube Cloud supports also cached test suites, using the data stored in Cloud. These can be identified by the read-only tag which suggests that either your agent is not connected, or that a particular test suite definition is no longer available in Kubernetes. - -## CLI - -You can use Testkube CLI to retrieve read-only tests and test suites, their executions, and download artifacts. Make sure to use version v1.16.7 or greater. You can use the `testkube version` command to check your client version. - -For example, listing tests: - -```sh -testkube get tests -``` - -```yaml - NAME | DESCRIPTION | TYPE | CREATED | LABELS | SCHEDULE | STATUS | EXECUTION ID ----------+-------------+-----------+-------------------------------+--------------------------------+----------+--------+--------------------------- - k6 | | k6/script | 0001-01-01 00:00:00 +0000 UTC | executor=k6-executor, | | failed | 64e4ace7dfca3109c5d2cc38 - | | | | test-type=k6-script | | | -``` - -You can also list and get executions as well as download artifacts: - -```sh -testkube get executions - -testkube get execution 64e4ace7ca80a3290a4a762f - -tk get artifact 654b867e234f24e69172b2ab -tk download artifacts 654b867e234f24e69172b2ab -``` diff --git a/docs/docs/testkube-cloud/articles/intro.md b/docs/docs/testkube-cloud/articles/intro.md deleted file mode 100644 index 8133ce29518..00000000000 --- a/docs/docs/testkube-cloud/articles/intro.md +++ /dev/null @@ -1,17 +0,0 @@ -# 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. - -## How does it work? - -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 - -You can start using Testkube Cloud by either: -- [**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). \ No newline at end of file diff --git a/docs/docs/testkube-cloud/articles/AI-test-insights.md b/docs/docs/testkube-pro/articles/AI-test-insights.md similarity index 94% rename from docs/docs/testkube-cloud/articles/AI-test-insights.md rename to docs/docs/testkube-pro/articles/AI-test-insights.md index 0b323e804c9..788f6ad817f 100644 --- a/docs/docs/testkube-cloud/articles/AI-test-insights.md +++ b/docs/docs/testkube-pro/articles/AI-test-insights.md @@ -16,7 +16,7 @@ The AI Insights feature on Testkube utilizes artificial intelligence to help you ## Example of Creating a cURL Test -Login to your Testkube cloud account and create a test. The test in this example will send an HTTP GET request to an endpoint and validate that the response - an IP address - is received. +Login to your Testkube pro account and create a test. The test in this example will send an HTTP GET request to an endpoint and validate that the response - an IP address - is received. Provide the following details: Name: `curl-url-test` diff --git a/docs/docs/testkube-pro/articles/architecture.md b/docs/docs/testkube-pro/articles/architecture.md new file mode 100644 index 00000000000..0d9c38e289d --- /dev/null +++ b/docs/docs/testkube-pro/articles/architecture.md @@ -0,0 +1,29 @@ +# Testkube Pro Architecture + +## Multiple Testkube Agents + +The main Testkube Pro feature is to have insights into multiple Testkube Pro Agents. +You can look at your Kubernetes clusters from a single dashboard and easily switch between different Testkube clusters. + +![multiple clusters](../../img/multiple-clusters.jpeg) + + +## Storing Results + +In Testkube standalone, all results are stored in the users cluster, so you need to be aware of MinIO and MongoDB. +Testkube Pro makes it easy for you. All data is stored in the Testkube Pro infrastructure so you don't need to worry about backups. + + +## Testkube Networking + +To simplify networking connections, the Testkube Agent is able to create a connection to Testkube Pro clusters. The Agent is registering itself into +Testkube Pro as a new environment. +This allows Testkube Pro to send commands which Testkube will manage in Agent mode. The connection is established from Testkube Agent to Testkube Pro. + +After installation, the Testkube Agent connects to Testkube Pro and starts listening for commands. +Additionally the Agent is connecting to the Testkube Pro REST API. + +![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-pro/articles/cached-results.md b/docs/docs/testkube-pro/articles/cached-results.md new file mode 100644 index 00000000000..f6b14c19741 --- /dev/null +++ b/docs/docs/testkube-pro/articles/cached-results.md @@ -0,0 +1,25 @@ +# Cached Test & Test Suite Results + +export const ProBadge = () => { + return ( + +

PRO FEATURE

+ + ); +} + + + +Testkube cached test results allows you to see and inspect test execution results even when your Testkube agent is offline. + +## Overview + +![offline-test](../../img/offline-list.png) + +Testkube Pro uses test execution data stored in Pro to allow you inspect past test executions. This feature also works when your agent is online, but the Testkube agent doesn't have the test definition available in Kubernetes. + +Cached test results appear with a read-only tag. These tests cannot be updated. If you want to get rid of old tests, you can go to the Test Settings page and click "Delete Test". + +![offline-test-suite](../../img/offline-test-suite.png) + +Similar to tests, Testkube Pro supports also cached test suites, using the data stored in Pro. These can be identified by the read-only tag which suggests that either your agent is not connected, or that a particular test suite definition is no longer available in Kubernetes. diff --git a/docs/docs/testkube-cloud/articles/environment-management.md b/docs/docs/testkube-pro/articles/environment-management.md similarity index 90% rename from docs/docs/testkube-cloud/articles/environment-management.md rename to docs/docs/testkube-pro/articles/environment-management.md index 7452a22effb..605da0a8cb2 100644 --- a/docs/docs/testkube-cloud/articles/environment-management.md +++ b/docs/docs/testkube-pro/articles/environment-management.md @@ -1,12 +1,12 @@ # Environment Management 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. +test insights to Testkube Pro and for managing your Kubernetes related cluster resources. ## Creating a New Environment -You can create a new environment from the "Environments" drop down in the header section of the Testkube Cloud UI. +You can create a new environment from the "Environments" drop down in the header section of the Testkube Pro UI. ![env-drop-down](../../img/env-drop-down.png) @@ -21,7 +21,7 @@ On the "General" tab, you can see environment information: * Connection state * Agent name * 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. +* Testkube CLI context command - To configure your Testkube CLI with pro context. You can also delete a given environment (be careful, this action can't be rolled-back!) diff --git a/docs/docs/testkube-cloud/articles/installing-agent.md b/docs/docs/testkube-pro/articles/installing-agent.md similarity index 80% rename from docs/docs/testkube-cloud/articles/installing-agent.md rename to docs/docs/testkube-pro/articles/installing-agent.md index 9c7944c738f..4cb6fb73832 100644 --- a/docs/docs/testkube-cloud/articles/installing-agent.md +++ b/docs/docs/testkube-pro/articles/installing-agent.md @@ -1,6 +1,6 @@ # Installing the Testkube Agent -Following steps, are under the assumption that you already have a TestKube Cloud account, if that's not the case, you can find a detailed description about how to get started with TestKube [here](../../articles/getting-started.md). +Following steps, are under the assumption that you already have a TestKube Pro account, if that's not the case, you can find a detailed description about how to get started with TestKube [here](../../articles/getting-started.md). ## Installation Steps @@ -34,10 +34,10 @@ You will need *Helm* installed and `kubectl` configured with access to your Kube ## 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) diff --git a/docs/docs/testkube-pro/articles/intro.md b/docs/docs/testkube-pro/articles/intro.md new file mode 100644 index 00000000000..d24bd569948 --- /dev/null +++ b/docs/docs/testkube-pro/articles/intro.md @@ -0,0 +1,17 @@ +# Testkube Pro + +Testkube Pro 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. + +## How does it work? + +The way Testkube Pro 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 + +You can start using Testkube Pro by either: +- [**Migrating Testkube Open Source**](./transition-from-oss.md) from your existing Testkube Open Source instance to a Pro instance. +- Creating a fresh installation, using [app.testkube.io](https://app.testkube.io). \ No newline at end of file diff --git a/docs/docs/testkube-cloud/articles/managing-cli-context.md b/docs/docs/testkube-pro/articles/managing-cli-context.md similarity index 82% rename from docs/docs/testkube-cloud/articles/managing-cli-context.md rename to docs/docs/testkube-pro/articles/managing-cli-context.md index 15399024bac..60b67d3cb43 100644 --- a/docs/docs/testkube-cloud/articles/managing-cli-context.md +++ b/docs/docs/testkube-pro/articles/managing-cli-context.md @@ -1,6 +1,6 @@ # Connecting from the CLI -To use Testkube CLI to connect to your Testkube Cloud install you will need to set the CLI Context. For that you will need a Testkube Cloud token. +To use Testkube CLI to connect to your Testkube Pro install you will need to set the CLI Context. For that you will need a Testkube Pro token. The token you create can have different roles associated with it for fine-grained control: diff --git a/docs/docs/testkube-cloud/articles/organization-management.md b/docs/docs/testkube-pro/articles/organization-management.md similarity index 100% rename from docs/docs/testkube-cloud/articles/organization-management.md rename to docs/docs/testkube-pro/articles/organization-management.md diff --git a/docs/docs/testkube-cloud/articles/running-parallel-tests-with-test-suite.md b/docs/docs/testkube-pro/articles/running-parallel-tests-with-test-suite.md similarity index 100% rename from docs/docs/testkube-cloud/articles/running-parallel-tests-with-test-suite.md rename to docs/docs/testkube-pro/articles/running-parallel-tests-with-test-suite.md diff --git a/docs/docs/testkube-cloud/articles/status-pages.md b/docs/docs/testkube-pro/articles/status-pages.md similarity index 99% rename from docs/docs/testkube-cloud/articles/status-pages.md rename to docs/docs/testkube-pro/articles/status-pages.md index a28bc870f06..b5ae4bf4677 100644 --- a/docs/docs/testkube-cloud/articles/status-pages.md +++ b/docs/docs/testkube-pro/articles/status-pages.md @@ -28,7 +28,7 @@ Testkube Status Pages is a feature within the Testkube software that allows you To access Testkube Status Pages: -1. Log in to your Testkube Cloud account. +1. Log in to your Testkube Pro account. 2. Go to the dashboard. 3. Click on "Status Pages" in the left navigation panel. diff --git a/docs/docs/testkube-cloud/articles/transition-from-oss.md b/docs/docs/testkube-pro/articles/transition-from-oss.md similarity index 60% rename from docs/docs/testkube-cloud/articles/transition-from-oss.md rename to docs/docs/testkube-pro/articles/transition-from-oss.md index 673b27bec65..6fbcb687025 100644 --- a/docs/docs/testkube-cloud/articles/transition-from-oss.md +++ b/docs/docs/testkube-pro/articles/transition-from-oss.md @@ -1,8 +1,8 @@ # Migrating from Testkube Open Source -If you have started using Testkube using the Open Source installation, you can migrate this instance 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 Pro. -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 Pro Agent mode. Testkube Pro Agent is the Testkube engine for controlling your Testkube instance using the managed solution. It sends data to Testkube's Pro Servers. ::: note @@ -15,7 +15,7 @@ Currently, we do not support uploading existing test logs and artifacts from you 1. Run the following command which will walk you through the migration process: ```sh -testkube cloud connect +testkube pro connect ``` -2. [Set your CLI Context to talk to Testkube Cloud](./managing-cli-context.md). \ No newline at end of file +2. [Set your CLI Context to talk to Testkube Pro](./managing-cli-context.md). \ No newline at end of file diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index aa6c965ae85..93e6d0cca30 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -101,8 +101,8 @@ const config = { }, announcementBar: { - id: "join-testkube-cloud", - content: 'New to Testkube? Unleash the power of cloud native testing in Kubernetes with Testkube. Get Started >', + id: "join-testkube-pro", + content: 'New to Testkube? Unleash the power of cloud native testing in Kubernetes with Testkube. Get Started >', backgroundColor: "#8951ff", textColor: "#fff", }, diff --git a/docs/redirects.js b/docs/redirects.js index 91d894fb583..892bf826c8a 100644 --- a/docs/redirects.js +++ b/docs/redirects.js @@ -280,32 +280,48 @@ const redirects = [ to: "/articles/templates", }, { - from: ["/testkube-cloud/intro", "/testkube-cloud"], - to: "/testkube-cloud/articles/intro", + from: ["/testkube-cloud/intro", "/testkube-cloud", "/testkube-cloud/articles/intro", "/testkube-pro/intro"], + to: "/testkube-pro/articles/intro", }, { - from: "/testkube-cloud/installing-agent", - to: "/testkube-cloud/articles/installing-agent", + from: ["/testkube-cloud/installing-agent", "/testkube-cloud/articles/installing-agent", "/testkube-pro/installing-agent"], + to: "/testkube-pro/articles/installing-agent", }, { - from: "/testkube-cloud/transition-from-oss", - to: "/testkube-cloud/articles/transition-from-oss", + from: ["/testkube-cloud/transition-from-oss", "/testkube-cloud/articles/transition-from-oss", "/testkube-pro/transition-from-oss"], + to: "/testkube-pro/articles/transition-from-oss", }, { - from: "/testkube-cloud/organization-management", - to: "/testkube-cloud/articles/organization-management", + from: ["/testkube-cloud/organization-management", "/testkube-cloud/articles/organization-management", "/testkube-pro/organization-management"], + to: "/testkube-pro/articles/organization-management", }, { - from: "/testkube-cloud/environment-management", - to: "/testkube-cloud/articles/environment-management", + from: ["/testkube-cloud/environment-management", "/testkube-cloud/articles/environment-management", "/testkube-pro/environment-management"], + to: "/testkube-pro/articles/environment-management", }, { - from: "/testkube-cloud/managing-cli-context", - to: "/testkube-cloud/articles/managing-cli-context", + from: ["/testkube-cloud/managing-cli-context", "/testkube-cloud/articles/managing-cli-context", "/testkube-pro/managing-cli-context"], + to: "/testkube-pro/articles/managing-cli-context", }, { - from: "/testkube-cloud/architecture", - to: "/testkube-cloud/articles/architecture", + from: ["/testkube-cloud/architecture", "/testkube-cloud/articles/architecture", "/testkube-pro/architecture"], + to: "/testkube-pro/articles/architecture", + }, + { + from: ["/testkube-cloud/articles/running-parallel-tests-with-test-suite","/testkube-pro/running-parallel-tests-with-test-suite"], + to: "/testkube-pro/articles/running-parallel-tests-with-test-suite", + }, + { + from: ["/testkube-cloud/articles/AI-test-insights", "/testkube-pro/AI-test-insights"], + to: "/testkube-pro/articles/AI-test-insights", + }, + { + from: ["/testkube-cloud/articles/status-pages", "/testkube-pro/status-pages"], + to: "/testkube-pro/articles/status-pages", + }, + { + from: ["/testkube-cloud/articles/cached-results", "/testkube-pro/cached-results"], + to: "/testkube-pro/articles/cached-results", }, { from: "/reference/helm-chart", diff --git a/docs/sidebars.js b/docs/sidebars.js index 0cf90b00050..0f44b690ee9 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -22,7 +22,7 @@ const sidebars = { type: "doc", id: "index", }, - items: ["articles/supported-tests", "articles/testkube-benefits", "articles/open-source-or-cloud"], + items: ["articles/supported-tests", "articles/testkube-benefits", "articles/open-source-or-pro"], }, { type: "doc", @@ -172,19 +172,19 @@ const sidebars = { }, { type: "category", - label: "Testkube Cloud", + label: "Testkube Pro", items: [ - "testkube-cloud/articles/intro", - "testkube-cloud/articles/installing-agent", - "testkube-cloud/articles/transition-from-oss", - "testkube-cloud/articles/organization-management", - "testkube-cloud/articles/environment-management", - "testkube-cloud/articles/managing-cli-context", - "testkube-cloud/articles/architecture", - "testkube-cloud/articles/running-parallel-tests-with-test-suite", - "testkube-cloud/articles/AI-test-insights", - "testkube-cloud/articles/status-pages", - "testkube-cloud/articles/cached-results", + "testkube-pro/articles/intro", + "testkube-pro/articles/installing-agent", + "testkube-pro/articles/transition-from-oss", + "testkube-pro/articles/organization-management", + "testkube-pro/articles/environment-management", + "testkube-pro/articles/managing-cli-context", + "testkube-pro/articles/architecture", + "testkube-pro/articles/running-parallel-tests-with-test-suite", + "testkube-pro/articles/AI-test-insights", + "testkube-pro/articles/status-pages", + "testkube-pro/articles/cached-results", ], }, {