faas-rs/faasd
1
0
Fork 0
mirror of https://github.com/openfaas/faasd.git synced 2025-06-15 11:26:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: improve multipass cloud-config and instructions

Browse Source 
Improve the Multipass cloud-config.txt by using the install.sh script
instead of stale install instructions. This ensures that the latest
release is installed and reduces the number of install instructions we
need to maintain.

Also, improve the instructions for using multipass by including a
one-line command for setting the correct ssh key _and_ starting the VM.

Finally, improve the markdown formatting by indenting the paragraph
bodies of the list items. This ensures that the content is properly
aligned with the bullet list.

Signed-off-by: Lucas Roesler <roesler.lucas@gmail.com>
This commit is contained in:
Lucas Roesler 2021-11-06 11:33:24 +01:00 committed by Alex Ellis
parent 77867f17e3
commit 551e6645b7
2 changed files with 66 additions and 75 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
cloud-config.txt
View File

@ -10,17 +10,7 @@ packages:
- git - git
runcmd: runcmd:
- curl -sLSf https://github.com/containerd/containerd/releases/download/v1.5.4/containerd-1.5.4-linux-amd64.tar.gz > /tmp/containerd.tar.gz && tar -xvf /tmp/containerd.tar.gz -C /usr/local/bin/ --strip-components=1 - curl -sfL https://raw.githubusercontent.com/openfaas/faasd/master/hack/install.sh | sh -s -
- curl -SLfs https://raw.githubusercontent.com/containerd/containerd/v1.5.4/containerd.service | tee /etc/systemd/system/containerd.service
- systemctl daemon-reload && systemctl start containerd
- systemctl enable containerd
- /sbin/sysctl -w net.ipv4.conf.all.forwarding=1
- mkdir -p /opt/cni/bin
- curl -sSL https://github.com/containernetworking/plugins/releases/download/v0.8.5/cni-plugins-linux-amd64-v0.8.5.tgz | tar -xz -C /opt/cni/bin
- mkdir -p /go/src/github.com/openfaas/
- cd /go/src/github.com/openfaas/ && git clone --depth 1 --branch 0.13.0 https://github.com/openfaas/faasd
- curl -fSLs "https://github.com/openfaas/faasd/releases/download/0.13.0/faasd" --output "/usr/local/bin/faasd" && chmod a+x "/usr/local/bin/faasd"
- cd /go/src/github.com/openfaas/faasd/ && /usr/local/bin/faasd install
- systemctl status -l containerd --no-pager - systemctl status -l containerd --no-pager
- journalctl -u faasd-provider --no-pager - journalctl -u faasd-provider --no-pager
- systemctl status -l faasd-provider --no-pager - systemctl status -l faasd-provider --no-pager

133
docs/MULTIPASS.md
View File

@ -27,111 +27,112 @@ It took me about 2-3 minutes to run through everything after installing multipas
* Get my cloud-config.txt file * Get my cloud-config.txt file
```sh ```sh
curl -sSLO https://raw.githubusercontent.com/openfaas/faasd/master/cloud-config.txt curl -sSLO https://raw.githubusercontent.com/openfaas/faasd/master/cloud-config.txt
``` ```
* Update the SSH key to match your own, edit `cloud-config.txt`:
Replace the 2nd line with the contents of `~/.ssh/id_rsa.pub`:
```
ssh_authorized_keys:
- ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC8Q/aUYUr3P1XKVucnO9mlWxOjJm+K01lHJR90MkHC9zbfTqlp8P7C3J26zKAuzHXOeF+VFxETRr6YedQKW9zp5oP7sN+F2gr/pO7GV3VmOqHMV7uKfyUQfq7H1aVzLfCcI7FwN2Zekv3yB7kj35pbsMa1Za58aF6oHRctZU6UWgXXbRxP+B04DoVU7jTstQ4GMoOCaqYhgPHyjEAS3DW0kkPW6HzsvJHkxvVcVlZ/wNJa1Ie/yGpzOzWIN0Ol0t2QT/RSWOhfzO1A2P0XbPuZ04NmriBonO9zR7T1fMNmmtTuK7WazKjQT3inmYRAqU6pe8wfX8WIWNV7OowUjUsv alex@alexr.local
```
* Boot the VM * Boot the VM
```sh The `cloud-config.txt` contains an ssh key to allow your local machine to access the VM. However, this must be updated with your local ssh key.
multipass launch --cloud-init cloud-config.txt --name faasd This command will update the key with your local public key value and start the VM.
```
```sh
sed "s/ssh-rsa.*/$(cat $HOME/.ssh/id_*.pub)/" cloud-config.txt | multipass launch --name faasd --cloud-init -
```
This can also be done manually, just replace the 2nd line of the `cloud-config.txt` with the coPntents of your public ssh key, usually either `~/.ssh/id_rsa.pub` or `~/.ssh/id_ed25519.pub`
```
ssh_authorized_keys:
- ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC8Q/aUYUr3P1XKVucnO9mlWxOjJm+K01lHJR90MkHC9zbfTqlp8P7C3J26zKAuzHXOeF+VFxETRr6YedQKW9zp5oP7sN+F2gr/pO7GV3VmOqHMV7uKfyUQfq7H1aVzLfCcI7FwN2Zekv3yB7kj35pbsMa1Za58aF6oHRctZU6UWgXXbRxP+B04DoVU7jTstQ4GMoOCaqYhgPHyjEAS3DW0kkPW6HzsvJHkxvVcVlZ/wNJa1Ie/yGpzOzWIN0Ol0t2QT/RSWOhfzO1A2P0XbPuZ04NmriBonO9zR7T1fMNmmtTuK7WazKjQT3inmYRAqU6pe8wfX8WIWNV7OowUjUsv alex@alexr.local
```
* Get the VM's IP and connect with `ssh` * Get the VM's IP and connect with `ssh`
```sh ```sh
multipass info faasd multipass info faasd
Name: faasd Name: faasd
State: Running State: Running
IPv4: 192.168.64.14 IPv4: 192.168.64.14
Release: Ubuntu 18.04.3 LTS Release: Ubuntu 18.04.3 LTS
Image hash: a720c34066dc (Ubuntu 18.04 LTS) Image hash: a720c34066dc (Ubuntu 18.04 LTS)
Load: 0.79 0.19 0.06 Load: 0.79 0.19 0.06
Disk usage: 1.1G out of 4.7G Disk usage: 1.1G out of 4.7G
Memory usage: 145.6M out of 985.7M Memory usage: 145.6M out of 985.7M
``` ```
Set the variable `IP`: Set the variable `IP`:
``` ```
export IP="192.168.64.14" export IP="192.168.64.14"
``` ```
You can also try to use `jq` to get the IP into a variable: You can also try to use `jq` to get the IP into a variable:
```sh ```sh
export IP=$(multipass info faasd --format json| jq -r '.info.faasd.ipv4[0]') export IP=$(multipass info faasd --format json| jq -r '.info.faasd.ipv4[0]')
``` ```
Connect to the IP listed: Connect to the IP listed:
```sh ```sh
ssh ubuntu@$IP ssh ubuntu@$IP
``` ```
Log out once you know it works. Log out once you know it works.
* Let's capture the authentication password into a file for use with `faas-cli` * Let's capture the authentication password into a file for use with `faas-cli`
``` ```
ssh ubuntu@$IP "sudo cat /var/lib/faasd/secrets/basic-auth-password" > basic-auth-password ssh ubuntu@$IP "sudo cat /var/lib/faasd/secrets/basic-auth-password" > basic-auth-password
``` ```
## Try faasd (OpenFaaS) ## Try faasd (OpenFaaS)
* Login from your laptop (the host) * Login from your laptop (the host)
``` ```
export OPENFAAS_URL=http://$IP:8080 export OPENFAAS_URL=http://$IP:8080
cat basic-auth-password | faas-cli login -s cat basic-auth-password | faas-cli login -s
``` ```
* Deploy a function and invoke it * Deploy a function and invoke it
``` ```
faas-cli store deploy figlet --env write_timeout=1s faas-cli store deploy figlet --env write_timeout=1s
echo "faasd" | faas-cli invoke figlet echo "faasd" | faas-cli invoke figlet
faas-cli describe figlet faas-cli describe figlet
# Run async # Run async
curl -i -d "faasd-async" $OPENFAAS_URL/async-function/figlet curl -i -d "faasd-async" $OPENFAAS_URL/async-function/figlet
# Run async with a callback # Run async with a callback
curl -i -d "faasd-async" -H "X-Callback-Url: http://some-request-bin.com/path" $OPENFAAS_URL/async-function/figlet curl -i -d "faasd-async" -H "X-Callback-Url: http://some-request-bin.com/path" $OPENFAAS_URL/async-function/figlet
``` ```
You can also checkout the other store functions: `faas-cli store list` You can also checkout the other store functions: `faas-cli store list`
* Try the UI * Try the UI
Head over to the UI from your laptop and remember that your password is in the `basic-auth-password` file. The username is `admin`: Head over to the UI from your laptop and remember that your password is in the `basic-auth-password` file. The username is `admin`:
``` ```
echo http://$IP:8080 echo http://$IP:8080
``` ```
* Stop/start the instance * Stop/start the instance
```sh ```sh
multipass stop faasd multipass stop faasd
``` ```
* Delete, if you want to: * Delete, if you want to:
``` ```
multipass delete --purge faasd multipass delete --purge faasd
``` ```
You now have a faasd appliance on your Mac. You can also use this cloud-init file with public cloud like AWS or DigitalOcean. You now have a faasd appliance on your Mac. You can also use this cloud-init file with public cloud like AWS or DigitalOcean.