Skip to content

Commit

Permalink
Skewer update
Browse files Browse the repository at this point in the history
  • Loading branch information
ssorj committed Feb 25, 2024
1 parent f9d5afd commit 218cd3c
Show file tree
Hide file tree
Showing 35 changed files with 90 additions and 10,181 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- NOTE: This file is generated from skewer.yaml. Do not edit it directly. -->

# Skupper Hello World

[![main](https://github.com/skupperproject/skupper-example-hello-world/actions/workflows/main.yaml/badge.svg)](https://github.com/skupperproject/skupper-example-hello-world/actions/workflows/main.yaml)
Expand Down Expand Up @@ -47,7 +49,6 @@ services without exposing the backend to the public internet.

<img src="images/entities.svg" width="640"/>


## Prerequisites

* The `kubectl` command-line tool, version 1.15 or later
Expand Down Expand Up @@ -370,7 +371,6 @@ the frontend.

<img src="images/sequence.svg" width="640"/>


## Next steps

Check out the other [examples][examples] on the Skupper website.
Expand Down
24 changes: 13 additions & 11 deletions external/skewer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,12 +180,13 @@ They are the following:
~~~
general/install_the_skupper_command_line_tool
general/link_your_sites
general/access_the_frontend
general/cleaning_up
kubernetes/set_up_your_namespaces
kubernetes/set_up_your_kubernetes_namespace # One namespace only
kubernetes/create_your_sites
kubernetes/link_your_sites
kubernetes/access_the_frontend
kubernetes/cleaning_up
podman/set_up_your_podman_network
hello_world/deploy_the_frontend_and_backend
hello_world/expose_the_backend
Expand All @@ -195,20 +196,20 @@ hello_world/cleaning_up

The `general` steps are generic (or pretty generic) with respect to
platform and application. The `kubernetes` and `podman` steps are
coupled to their platform. The `hello_world` steps are coupled to the
Skupper Hello World app.
coupled to their platform. The `hello_world` steps are specific to
the Skupper Hello World application.

**Note:** The `general/link_your_sites` and `general/cleaning_up`
steps are less generic than the other `general` steps. For example,
`general/cleaning_up` doesn't delete any application workoads. Check
that the text and commands these steps produce are doing what you need
for your example. If not, you need to provide a custom step.
**Note:** The `link_your_sites` and `cleaning_up` steps are less
generic than the other `general` steps. For example, `cleaning_up`
doesn't delete any application workoads. Check that the text and
commands these steps produce are doing what you need for your example.
If not, you need to provide a custom step.

You can create custom steps based on the standard steps by overriding
the `title`, `preamble`, `commands`, or `postamble` fields.

~~~ yaml
- standard: general/cleaning_up
- standard: kubernetes/cleaning_up
commands:
east:
- run: skupper delete
Expand All @@ -229,7 +230,8 @@ placeholder:
Note: You may also want to flirp your krupke.
~~~

A typical mix of standard and custom steps might look like this:
A typical mix of standard and custom steps for a Kubernetes-based
example might look like this:

~~~ yaml
steps:
Expand All @@ -240,7 +242,7 @@ steps:
- standard: kubernetes/link_your_sites
<your-custom-expose-step>
<your-custom-access-step>
- standard: general/cleaning_up
- standard: kubernetes/cleaning_up
~~~

The step commands are separated into named groups corresponding to the
Expand Down
10 changes: 2 additions & 8 deletions external/skewer/example/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<!-- NOTE: This file is generated from skewer.yaml. Do not edit it directly. -->

# Skupper Hello World

[![main](https://github.com/skupperproject/skewer/actions/workflows/main.yaml/badge.svg)](https://github.com/skupperproject/skewer/actions/workflows/main.yaml)
Expand Down Expand Up @@ -32,12 +34,10 @@ across cloud providers, data centers, and edge sites.

An overview


## Prerequisites

Some prerequisites


## Step 1: Install the Skupper command-line tool

This example uses the Skupper command-line tool to deploy Skupper.
Expand Down Expand Up @@ -249,7 +249,6 @@ _**West:**_

~~~ shell
if [ -n "${SKEWER_FAIL}" ]; then expr 1 / 0; fi

~~~

## Step 7: Expose the backend
Expand Down Expand Up @@ -323,7 +322,6 @@ navigating to `http://<external-ip>:8080/` in your browser.
To remove Skupper and the other resources from this exercise, use
the following commands:


And more!

_**West:**_
Expand All @@ -343,18 +341,14 @@ kubectl delete deployment/backend

## Summary



More summary


## Next steps

Check out the other [examples][examples] on the Skupper website.

More steps


## About this example

This example was produced using [Skewer][skewer], a library for
Expand Down
1 change: 1 addition & 0 deletions external/skewer/example/python/plano
24 changes: 0 additions & 24 deletions external/skewer/example/python/plano/__init__.py

This file was deleted.

112 changes: 0 additions & 112 deletions external/skewer/example/python/plano/_testproject/.plano.py

This file was deleted.

Empty file.

This file was deleted.

This file was deleted.

Loading

0 comments on commit 218cd3c

Please sign in to comment.