Skip to content

Commit

Permalink
Documenting running cli in docker (#2724)
Browse files Browse the repository at this point in the history
* Documenting running cli in docker

Documenting how to run the CLI inside of docker

* Update docs/docs/ci-cd-automation/overview.md

Co-authored-by: Julianne Fermi <julianne@kubeshop.io>

* Update docs/docs/cli/configuring-your-cli.md

Co-authored-by: Julianne Fermi <julianne@kubeshop.io>

* Update docs/docs/cli/configuring-your-cli.md

Co-authored-by: Sebastian Choren <schoren@users.noreply.github.com>

---------

Co-authored-by: Julianne Fermi <julianne@kubeshop.io>
Co-authored-by: Sebastian Choren <schoren@users.noreply.github.com>
  • Loading branch information
3 people committed Jun 14, 2023
1 parent 75d7384 commit c4464c2
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 3 deletions.
17 changes: 14 additions & 3 deletions docs/docs/ci-cd-automation/overview.md
Expand Up @@ -8,12 +8,23 @@ You can find guides for:
- [Testkube](./testkube-pipeline)
- [Tekton](./tekton-pipeline)

:::note
If you want to see more examples with other CI/CD tools, let us know by [opening an issue in GitHub](https://github.com/kubeshop/tracetest/issues/new/choose)!
:::

Tracetest is designed to work with all CI/CD platforms and automation tools. To enable Tracetest to run in CI/CD environments, make sure to [install the Tracetest CLI](../getting-started/installation.mdx) and configure it to access your [Tracetest server](../configuration/server.md).

You can also directly execute the Tracetest CLI from a Docker image rather than installing the CLI on your local machine. This can be convenient when you wish to execute the CLI in a CI/CD environment.

**How to Use**:

```sh
docker run --rm -it -v$(pwd):$(pwd) -w $(pwd) --entrypoint tracetest kubeshop/tracetest:latest -s http://host.docker.internal:11633/ test run --definition <file-path> --wait-for-result
```

To read more about integrating Tracetest with CI/CD tools, check out tutorials in our blog:

- [Integrating Tracetest with GitHub Actions in a CI pipeline](https://kubeshop.io/blog/integrating-tracetest-with-github-actions-in-a-ci-pipeline)

:::note
If you want to see more examples with other CI/CD tools, let us know by [opening an issue in GitHub](https://github.com/kubeshop/tracetest/issues/new/choose)!
:::


13 changes: 13 additions & 0 deletions docs/docs/cli/configuring-your-cli.md
Expand Up @@ -64,3 +64,16 @@ tracetest test run --definition <file-path>
**Options**:

`--wait-for-result`: The CLI will only exit after the test run has completed (the trace was retrieved and assertions were executed).

### Running Tracetest CLI From Docker

There are times when it is easier to directly execute the Tracetest CLI from a Docker image rather than installing the CLI on your local machine. This can be convenient when you wish to execute the CLI in a CI/CD environment.


**How to Use**:

```sh
docker run --rm -it -v$(pwd):$(pwd) -w $(pwd) --network host --entrypoint tracetest kubeshop/tracetest:latest -s http://localhost:11633/ test run --definition <file-path> --wait-for-result
```


0 comments on commit c4464c2

Please sign in to comment.