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

     1  ![Testkube Logo](https://raw.githubusercontent.com/kubeshop/testkube/main/assets/testkube-color-gray.png)
     2  
     3  # Welcome to TestKube Artillery Executor
     4  
     5  TestKube Artillery Executor is a test executor for [TestKube](https://testkube.io).  
     6  You can use it to perform load and performance testing for your application running on the cluster.
     7  
     8  # What is an Executor?
     9  
    10  Executor is nothing more than a program wrapped into Docker container which gets JSON (testube.Execution) OpenAPI based document as an input and returns a stream of JSON output lines (testkube.ExecutorOutput), where each output line is simply wrapped in this JSON, similar to the structured logging idea. 
    11  
    12  # Why Artillery ?
    13  
    14  Artillery is a modern, powerful & easy-to-use performance testing toolkit. Use it to ship scalable applications that stay performant & resilient under high load.
    15  
    16  Artillery prioritizes developer productivity and happiness, and follows the "batteries-included" philosophy.
    17  
    18  
    19  # Usage
    20  
    21  ## You need to register and deploy the executor in your cluster
    22  
    23    ```yaml
    24    apiVersion: executor.testkube.io/v1
    25    kind: Executor
    26    metadata:
    27      name: artillery-executor
    28      namespace: testkube
    29    spec:
    30      image: kubeshop/testkube-executor-artillery:latest
    31      types:
    32      - artillery/test
    33    ```
    34  
    35    ```
    36    kubectl apply -f examples/artillery-executor.yaml
    37    ```
    38  ## To Create And Run Artillery based tests run following commands
    39  ```
    40  kubectl testkube create test --git-uri https://github.com/kubeshop/testkube-executor-artillery.git --git-branch main --git-path examples/test.yaml --name artillery-example-test --test-content-type git-file --type artillery/test
    41  
    42  ```
    43  ```
    44  kubectl testkube run test artillery-example-test -f
    45  ```
    46  ## To Download Artillery Test Report
    47  
    48  ```
    49   kubectl-testkube download artifacts  [ Test ExecutionID ] --download-dir [ Destination Directory ]
    50  ```
    51  
    52  
    53  # Issues and enchancements 
    54  
    55  Please follow the main [TestKube repository](https://github.com/kubeshop/testkube) for reporting any [issues](https://github.com/kubeshop/testkube/issues) or [discussions](https://github.com/kubeshop/testkube/discussions)
    56  
    57  
    58  # Testkube 
    59  
    60  For more info go to [main testkube repo](https://github.com/kubeshop/testkube)
    61  
    62  ![Release](https://img.shields.io/github/v/release/kubeshop/testkube) [![Releases](https://img.shields.io/github/downloads/kubeshop/testkube/total.svg)](https://github.com/kubeshop/testkube/tags?label=Downloads) ![Go version](https://img.shields.io/github/go-mod/go-version/kubeshop/testkube)
    63  
    64  ![Docker builds](https://img.shields.io/docker/automated/kubeshop/testkube-api-server) ![Code build](https://img.shields.io/github/workflow/status/kubeshop/testkube/Code%20build%20and%20checks) ![Release date](https://img.shields.io/github/release-date/kubeshop/testkube)
    65  
    66  ![Twitter](https://img.shields.io/twitter/follow/thekubeshop?style=social) ![Slack](https://testkubeworkspace.slack.com/join/shared_invite/zt-2arhz5vmu-U2r3WZ69iPya5Fw0hMhRDg#/shared-invite/email)
    67   #### [Documentation](https://docs.testkube.io) | [Slack](https://testkubeworkspace.slack.com/join/shared_invite/zt-2arhz5vmu-U2r3WZ69iPya5Fw0hMhRDg#/shared-invite/email)