Categorygithub.com/tempestdx/examples
repository
0.0.0-20250127183922-1b8f09e1c6d8
Repository: https://github.com/tempestdx/examples.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author

# README

Tempest Private App Examples

The official Tempest Private App examples repository.

OpenTofu

The OpenTofu example shows how to execute a simple OpenTofu configuration, and interact with the resources in Tempest.

Usage

  1. Run the app with the CLI from with the examples/ directory.

Example

$ tempest app describe opentofu:v1

Tempest App Description
-----------------------

Describing app: opentofu:v1
Location: tempestdx/examples/apps/opentofu/v1/module/apps/opentofu/v1

Resource Type: S3 Bucket

Operations Supported:
- ✅ Read
- ❌ List
- ✅ Create
- ✅ Update
- ✅ Delete

Health Check Supported: ✅

$ tempest app test opentofu:v1 --operation create --type s3_bucket --input '{"name":"my-test-bucket"}' --env SECRET_KEY=abcd123 --env ACCESS_KEY=12345

Resource created with ID:  arn:aws:s3:::my-test-bucket
Properties:
{
  "arn": "arn:aws:s3:::my-test-bucket",
  "bucket": "my-test-bucket",
  "region": "us-east-1",
  "versioning": "Suspended"
}

Dashboards

The Dashboards example implements a Private App that interacts with the fictional "Dashboards" server found in deps/. This example showcases how Tempest can orchestrate your custom in-house servers via Private Apps.

Usage

  1. In one terminal, run the dashboards server. go run deps/dashboards/server/main.go
  2. In another terminal, navigate to the tempestdx/examples repository and use the app.

Example

$ go run deps/dashboards/server/main.go
Server started at :8080

$ tempest app describe dashboards:v1
Tempest App Description
-----------------------

Describing app: dashboards:v1
Location: /Users/mike/git/tempestdx/examples/apps/dashboards/v1

Resource Type: Dashboard

Operations Supported:
- ✅ Read
- ✅ List
- ✅ Create
- ✅ Update
- ✅ Delete

Health Check Supported: ✅

$ tempest app test dashboards:v1 --operation create --type dashboard --input '{"name": "my-example-dashboard"}'
Resource created with ID:  6Oh8ZeHr
Properties:
{
  "description": "",
  "id": "6Oh8ZeHr",
  "name": "my-example-dashboard",
  "project_id": "TEMPESTCLIFoWJFMwo"
}

$ tempest app test dashboards:v1 --operation delete --type dashboard -e 6Oh8ZeHr
Resource deleted with ID:  6Oh8ZeHr

Support

To share any requests, bugs or comments, please open an issue or submit a pull request.