Podtato-head is a cloud-native application built to colorfully demonstrate delivery scenarios using different tools and services. It is intended to help application delivery support teams test and decide which of these to use. In this repository, you find a set of delivery scenarios for podtato-head.
Find the following set of delivery scenarios in the delivery directory. Each example scenario delivers the same end result: an API service which communicates with other API services and returns HTML composed of all their responses.
Each delivery scenario includes a walkthrough (README.md) describing how to
- install required supporting infrastructure
- deliver podtato-head using the infrastructure
- And test that podtato-head is operating as expected.
Each delivery scenario also includes a test (make test) which automates the steps described in the walkthrough. You can pause a test after tests run and before teardown by setting the env var WAIT_FOR_DELETE=1, as in WAIT_FOR_DELETE=1 ./delivery/flux/test.sh. This lets you examine what the README and scripts do.
If you have a delivery scenario you'd like to add, please submit a pull request. We'd love to see what you've done!
We provided a template for you (./delivery_template). You can simply prepare this for your service using make new-scenario NAME=<YOUR_SERVICE_NAME>.
Then you can proceed as follows:
- Create the Walkthrough in your README.md
- Automate the steps (install, deliver, uninstall) in the Makefile
- Write a test script which runs the steps in the Makefile and verifies the result. Currently we are supporting KUTTL and shell scripts in our test framework. If you need additional tools, please open up an issue.
- Test your scenario by running
make testin the root directory of the repository. - Submit a pull request
- Ensure that your scenario is tested in the CI pipeline and everything works
- Celebrate!