This commit is contained in:
Roberto Alsina 2024-06-30 20:23:53 -03:00
parent a01488c677
commit 96214e6d07
3 changed files with 71 additions and 1 deletions

1
.gitignore vendored
View File

@ -1,4 +1,3 @@
/docs/
/lib/ /lib/
/bin/ /bin/
/.shards/ /.shards/

71
docs/funkos.md Normal file
View File

@ -0,0 +1,71 @@
# Funkos What, Why, How
A funko is the equivalent of a AWS lambda. It's the unit
of deployment for FaaSO.
A funko is a folder containing a metadata `funko.yml` file
and source code in any language supported by a *runtime*
Think of a runtime as a template that gets merged with yout
funko and produces a full containerized application.
FaaSO can use your funko and its runtime to create a Docker image.
That docker image can be built in a server by the FaaSO proxy or it can be
built locally just like any docker image.
Then we can start it, either locally or in the server, using the proxy.
```mermaid
flowchart TD
subgraph funko_hello
A(fa:fa-code Metadata)
B(fa:fa-code Code in language X)
end
R(runtime for X)
C(fa:fa-box Containerized Application)
D(fa:fa-image Docker Image)
E(fa:fa-server FaaSO Proxy)
F(Container Instance Running In Server)
G(Container Instance Running Locally)
funko_hello --> C -- faaso build --> D
R --> C
D --> E -- faaso up --> F
D -- faaso up -l --> G
```
How is that application reached? FaaSO will usually run the image
in a *opinionated* way. All funkos listen in port 3000 in their own
container instances, and they are all segregated into a network called
faaso-net.
The faaso-proxy container will automatically proxy all requests so if you access the URL `http://faaso-proxy:8888/funko/hello/foo` that will be
proxied to `/foo` in the `hello` funko.
This is all done via naming conventions. You can create your own `faaso-whatever` container, add it to the `faaso-net` and faaso will
happily consider it a funko.
In the same way all funkos are simply docker containers running in that
network, with names following that convention. There is zero magic
involved.
```mermaid
flowchart TD
subgraph faaso-net
faaso-proxy
faaso-funko1
faaso-funko2
faaso-hello
end
client -- GET /funko/hello/foo --> faaso-proxy
faaso-proxy -- GET /foo --> faaso-hello
```
The dynamic proxying is achieved by reading the current state of
Docker and just adapt to it using the naming conventions mentioned
above.