Skip to content

Commit

Permalink
Added instructions to run Flame example app
Browse files Browse the repository at this point in the history
  • Loading branch information
sleipnir committed Dec 15, 2023
1 parent 5955b5d commit 6933050
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 18 deletions.
6 changes: 5 additions & 1 deletion flame_example/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ image=${registry}/flame-parent-example:${version}

.PHONY: all

all: clean-all build build-image create-kind-cluster create-k8s-namespace load-kind-images
all: clean-all build build-image create-kind-cluster create-k8s-namespace load-kind-images apply-k8s-manifests

clean:
mix deps.clean --all
Expand All @@ -31,3 +31,7 @@ load-kind-images:

create-k8s-namespace:
kubectl create ns flame

apply-k8s-manifests:
kubectl -n flame apply -f .k8s/pool.yaml
kubectl -n flame apply -f .k8s/deployment.yaml
22 changes: 5 additions & 17 deletions flame_example/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,9 @@
# FlameExample
# Flame Example

**TODO: Add description**
Example of a Flame application using the flame_k8s backend based on the Operator Pattern.

## Installation
## Installation and Run

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `flame_example` to your list of dependencies in `mix.exs`:

```elixir
def deps do
[
{:flame_example, "~> 0.1.0"}
]
end
```sh
$ make all
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at <https://hexdocs.pm/flame_example>.

0 comments on commit 6933050

Please sign in to comment.