Skip to content

Commit

Permalink
fix: update docs
Browse files Browse the repository at this point in the history 
Signed-off-by: Vladislav Sukhin <[email protected]>
  • Loading branch information
@vsukhin
vsukhin committed Jul 11, 2024
1 parent 46a10ae commit 235e03d
Showing 1 changed file with 7 additions and 267 deletions.
274 changes: 7 additions & 267 deletions docs/docs/articles/webhooks.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -552,7 +552,7 @@ To enable a webhook again, you can either set the field `disabled` to `"false"`

### Disabling Webhooks on Other Resources

Disabling webhooks can also be done directly on an execution, a test, a test suite and a test workflow. This way the notifications can be disabled temporarily during creation or when they need to be fixed or updated. The CLI offers the flag `--disable-webhooks`, the API the parameter `disableWebhooks`, and the CRDs `disableWebhooks`. When not set explicitly, webhooks will be enabled by default.
Disabling webhooks can also be done directly on an execution of a test, a test suite and a test workflow. This way the notifications can be disabled temporarily during running the execution. The CLI offers the flag `--disable-webhooks`, the API the parameter `disableWebhooks`. When not set explicitly, webhooks will be enabled by default.

#### Disabling Webhooks on Tests

Expand All @@ -563,38 +563,7 @@ Disabling webhooks can also be done directly on an execution, a test, a test sui
Use the flag `--disable-webhooks` on the CLI:

```bash
testkube create test --name k6-test --type k6/script --test-content-type file-uri --file k6-test.js --disable-webhooks
```

</TabItem>

<TabItem value="crd" label="CRD">

Use the attribute `disableWebhooks` in the `executionRequest` on CRD level.

```yaml
apiVersion: tests.testkube.io/v3
kind: Test
metadata:
name: k6-test
namespace: testkube
spec:
content:
data: |
import http from 'k6/http';
import { check } from 'k6';
export default function () {
const baseURI = `${__ENV.API_URI || 'http://google.com'}`;

check(http.get(`${baseURI}/joke`), {
'joke should be about Chuck': r => r.body.includes("Chuck") // this should fail
});
}
type: file-uri
executionRequest:
disableWebhooks: true
type: k6/script
testkube run test k6-test --disable-webhooks
```

</TabItem>
Expand All @@ -604,47 +573,9 @@ spec:
The API expects a boolean value of the form:

```json
"executionRequest": {
"disableWebhooks": true
}
```

Inside a test this would look like the following:

```json
{
"name": "test-from-api",
"namespace": "testkube",
"type": "k6/script",
"content": {
"type": "string",
"data": "import http from 'k6/http';\n import { sleep } from 'k6';\n export default function () {\n const res = http.get(`http://${__ENV.MY_HOSTNAME}/`);\n sleep(1);\n}"
},
"labels": {
"env": "prod",
"app": "backend"
},
"variables": {
"var1": {
"name": "var1",
"value": "1",
"type": "basic"
},
"var2": {
"name": "var2",
"value": "2",
"type": "secret",
"secretRef": {
"namespace": "testkube",
"name": "var2name",
"key": "var2key"
}
}
},
"executionRequest": {
{
"disableWebhooks": true
}
}
```

</TabItem>
Expand All @@ -662,44 +593,7 @@ The examples show only the `create` operations, however these instructions work
Use the flag `--disable-webhooks` on the CLI:

```bash
cat ts.json | /Users/lilla/bin/kubectl-testkube create testsuite --disable-webhooks
```

</TabItem>

<TabItem value="crd" label="CRD">

Use the attribute `disableWebhooks` in the `executionRequest` on CRD level:

```yaml
apiVersion: tests.testkube.io/v3
kind: TestSuite
metadata:
name: testkube-suite
namespace: testkube
spec:
description: Testkube test suite, api, dashboard and performance
executionRequest: { disableWebhooks: true }
steps:
- execute:
- delay: 0s
test: testkube-api
- delay: 0s
test: testkube-dashboard
stopOnFailure: false
- execute:
- delay: 1s
stopOnFailure: false
- downloadArtifacts:
previousTestNames:
- testkube-api
execute:
- delay: 0s
test: testkube-dashboard
- delay: 1s
- delay: 0s
test: testkube-homepage
stopOnFailure: false
testkube run testsuite test-suite-1 --disable-webhooks
```

</TabItem>
Expand All @@ -709,33 +603,9 @@ spec:
The API expects a boolean value of the form:

```json
"executionRequest": {
"disableWebhooks": true
}
```

Inside a test suite this would look like the following:

```json
{
"name": "test-suite-1",
"namespace": "testkube",
"description": "Example Test Suite",
"steps": [
{
"stopOnFailure": false,
"execute": [
{
"test": "existing-test"
}
]
}
],
"created": "2024-06-03T10:40:44Z",
"executionRequest": {
{
"disableWebhooks": true
}
}
```

</TabItem>
Expand All @@ -753,66 +623,7 @@ The examples show only the `create` operations, however these instructions work
Use the flag `--disable-webhooks` on the CLI:

```bash
testkube create testworkflow --file wf.yaml --name test-workflow --disable-webhooks
```

</TabItem>

<TabItem value="crd" label="CRD">

For disabling webhooks on the test workflows, set the following on the workflow spec:

```yaml
notifications:
disableWebhooks: true
```
Example usage:
```yaml
apiVersion: testworkflows.testkube.io/v1
kind: TestWorkflow
metadata:
name: test-workflow
namespace: testkube
spec:
container:
resources:
requests:
cpu: 128m
memory: 128Mi
workingDir: /data/repo/test/k6/executor-tests
content:
git:
paths:
- test/k6/executor-tests/k6-smoke-test.js
revision: main
uri: https://github.com/kubeshop/testkube
notifications:
disableWebhooks: true
steps:
- artifacts:
paths:
- "*"
workingDir: /data/artifacts
container:
image: grafana/k6:0.49.0
name: Run test
run:
args:
- run
- k6-smoke-test.js
- -e
- K6_ENV_FROM_PARAM=K6_ENV_FROM_PARAM_value
env:
- name: K6_SYSTEM_ENV
value: K6_SYSTEM_ENV_value
- name: K6_WEB_DASHBOARD
value: "true"
- name: K6_WEB_DASHBOARD_EXPORT
value: /data/artifacts/k6-test-report.html
setup:
- shell: mkdir /data/artifacts
testkube run testworkflow test-workflow --disable-webhooks
```

</TabItem>
Expand All @@ -822,82 +633,11 @@ spec:
The API expects the following object set under the `spec` attribute:

```json
"notifications": {
{
"disableWebhooks": true
}
```

Example usage:

```json
{
"name": "wf1",
"namespace": "testkube",
"created": "2024-04-04T09:15:12Z",
"spec": {
"content": {
"git": {
"uri": "https://github.com/kubeshop/testkube",
"revision": "main",
"paths": ["test/k6/executor-tests/k6-smoke-test.js"]
}
},
"container": {
"workingDir": {
"value": "/data/repo/test/k6/executor-tests"
},
"resources": {
"requests": {
"cpu": "128m",
"memory": "128Mi"
}
}
},
"steps": [
{
"name": "Run test",
"run": {
"env": [
{
"name": "K6_SYSTEM_ENV",
"value": "K6_SYSTEM_ENV_value"
},
{
"name": "K6_WEB_DASHBOARD",
"value": "true"
},
{
"name": "K6_WEB_DASHBOARD_EXPORT",
"value": "/data/artifacts/k6-test-report.html"
}
],
"args": {
"value": ["run", "k6-smoke-test.js", "-e", "K6_ENV_FROM_PARAM=K6_ENV_FROM_PARAM_value"]
}
},
"container": {
"image": "grafana/k6:0.49.0"
},
"artifacts": {
"workingDir": {
"value": "/data/artifacts"
},
"paths": ["*"]
},
"setup": [
{
"shell": "mkdir /data/artifacts"
}
]
}
],
"notifications": {
"disableWebhooks": true
}
}
}
```

</TabItem>

</Tabs>
Expand Down

0 comments on commit 235e03d

Please sign in to comment.