github.com/kubeshop/testkube@v1.17.23/contrib/executor/example/README.md (about)

     1  ![TestKube Logo](https://raw.githubusercontent.com/kubeshop/testkube/main/assets/logo-dark-text-full.png)
     2  
     3  # Welcome to TestKube Executor example
     4  
     5  TestKube Executor eample is simple test which checks if `GET` request for URI returns `200 OK` status - it's purpose was for showing how to extend testkube with custom executor. 
     6  
     7  # What is executor
     8  
     9  Executor is nothing more than program wrapped into Docker container which gets json (testube.Execution) OpenAPI based document, and returns stream of json output lines (testkube.ExecutorOutput) - each output line is simply wrapped in this JSON, like in structured logging idea. 
    10  
    11  
    12  # Issues and enchancements 
    13  
    14  Please follow to main TestKube repository for reporting any [issues](https://github.com/kubeshop/testkube/issues) or [discussions](https://github.com/kubeshop/testkube/discussions)
    15  
    16  ## Running executor example
    17  
    18  4. Build and push dockerfile to some repository
    19  
    20  5. Register Executor Custom Resource in your cluster 
    21  
    22  ```yaml
    23  apiVersion: executor.testkube.io/v1
    24  kind: Executor
    25  metadata:
    26    name: example-executor
    27    namespace: testkube
    28  spec:
    29    executor_type: job
    30    image: kubeshop/testkube-example-executor:0.0.1 # pass your repository and tag
    31    types:
    32    - example/test
    33    volume_mount_path: /mnt/artifacts-storage
    34    volume_quantity: 10Gix
    35  
    36  ```
    37  
    38  Set up volumes as in following example if you want to use artifacts storage (can be downloaded later in dashboard or by `kubectl testkube` plugin)
    39  
    40  
    41  ## Other examples
    42  
    43  - [Executor template](https://github.com/kubeshop/testkube-executor-template) - was used to create this example
    44  - [Postman executor](https://github.com/kubeshop/testkube-executor-postman)
    45  - [Cypress executor](https://github.com/kubeshop/testkube-executor-cypress)
    46  - [Curl executor](https://github.com/kubeshop/testkube-executor-curl)
    47