Skip to content

Commit 74f50f4

Browse files
committed
Remove swarm references
Closes: #185 Signed-off-by: Alex Ellis (OpenFaaS Ltd) <[email protected]>
1 parent 56d1f96 commit 74f50f4

File tree

5 files changed

+11
-98
lines changed

5 files changed

+11
-98
lines changed

README.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Finally the labs cover more advanced topics and give suggestions for further lea
1414

1515
## Requirements:
1616

17-
We walk through how to install these requirements in [Lab 1](./lab1.md). Please do [Lab 1](./lab1.md) before you attend an instructor-led workshop. At the very least you should [install Docker](./lab1.md#docker) and [pre-pull the OpenFaaS images](./lab1.md#Pre-pull-the-system-images).
17+
We walk through how to install these requirements in [Lab 1](./lab1.md). Please do [Lab 1](./lab1.md) before you attend an instructor-led workshop.
1818

1919
* Functions will be written in Python, so prior programming or scripting experience is preferred
2020
* Install the recommended code-editor / IDE [VSCode](https://code.visualstudio.com/download)
@@ -36,13 +36,7 @@ If you're taking an instructor-led workshops then a link will be shared to join
3636

3737
In Lab 1 you will pick your track and then throughout the labs look out for any special commands needed for the container orchestrator for your track.
3838

39-
### Docker Swarm (beginners)
40-
41-
The easiest and simplest way to learn about OpenFaaS is by deploying Docker Swarm, this is because it is already built into the Docker distribution and has more limited extensibility.
42-
43-
The knowledge you build up and the functions you create are both transferrable and portable between Docker Swarm and Kubernetes.
44-
45-
### Kubernetes (intermediate)
39+
### Kubernetes
4640

4741
You can also learn about Serverless on Kubernetes using OpenFaaS.
4842

@@ -51,7 +45,7 @@ The recommendation from the OpenFaaS community is that you run Kubernetes in pro
5145
## [Lab 1 - Prepare for OpenFaaS](./lab1.md)
5246

5347
* Install pre-requisites
54-
* Set up a single-node cluster with Docker Swarm or Kubernetes
48+
* Set up a single-node cluster with Kubernetes
5549
* Docker Hub account
5650
* OpenFaaS CLI
5751
* Deploy OpenFaaS
@@ -125,7 +119,7 @@ The recommendation from the OpenFaaS community is that you run Kubernetes in pro
125119
## [Lab 10 - Advanced Feature - Secrets](./lab10.md)
126120

127121
* Adapt issue-bot to use a secret
128-
* Create a Swarm secret
122+
* Create a Kubernetes secret with faas-cli
129123
* Access the secret within the function
130124

131125
## [Lab 11 - Advanced feature - Trust with HMAC](./lab11.md)

lab1.md

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
<img src="https://github.com/openfaas/media/raw/master/OpenFaaS_Magnet_3_1_png.png" width="500px"></img>
44

5-
OpenFaaS requires a [Kubernetes](https://kubernetes.io) or [Docker Swarm](https://docs.docker.com/engine/swarm/) cluster to operate. You can use a single-node cluster or a multi-node cluster, whether that's on your laptop or in the cloud.
5+
OpenFaaS requires a [Kubernetes](https://kubernetes.io) cluster to operate. You can use a single-node cluster or a multi-node cluster, whether that's on your laptop or in the cloud.
66

77
The basic primitive for any OpenFaaS function is a Docker image, which is built using the `faas-cli` tool-chain.
88

99
## Pre-requisites:
1010

11-
Let's install Docker, the OpenFaaS CLI and pick Kubernetes or Swarm to proceed.
11+
Let's install Docker, the OpenFaaS CLI and setup Kubernetes.
1212

1313
### Docker
1414

@@ -92,23 +92,6 @@ export OPENFAAS_PREFIX="" # Populate with your Docker Hub username
9292

9393
### Setup a single-node cluster
9494

95-
If you're taking part in an instructor-lead event then the organiser may ask you to use Docker Swarm, because it's much quicker and easier to set up in a short period of time. For some workshops you will be using Kubernetes.
96-
97-
If you are working independently then choice is entirely your own.
98-
99-
Start the first lab by picking one of the tracks below:
100-
101-
* Docker Swarm: [Lab 1a](./lab1a.md)
95+
The labs use Kubernetes, and still have some references to Docker Swarm. Please ignore those references as Swarm is no longer supported by the OpenFaaS community. Some of the workshop labs will work for faasd, but you may need to alter the commands and we do not provide support for the workshop when taken with faasd.
10296

10397
* Kubernetes: [Lab 1b](./lab1b.md)
104-
105-
106-
### Pre-pull the system images (only if using Swarm)
107-
108-
Pull the most recent OpenFaaS images.
109-
110-
```sh
111-
curl -sSL https://raw.githubusercontent.com/openfaas/faas/master/docker-compose.yml | grep image | awk -F " " '{print $NF}' | xargs -L1 docker pull
112-
```
113-
114-
This should offset the impact on the workshop WiFi of multiple attendees trying to pull the images at the same time.

lab1a.md

Lines changed: 0 additions & 65 deletions
This file was deleted.

lab2.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,9 +181,11 @@ where `IP_ADDRESS` is your corresponding IP for Kubernetes.
181181
Or you may run this port-forwarding command in order to be able to access Grafana on `http://127.0.0.1:3000`:
182182

183183
```sh
184-
$ kubectl port-forward deployment/grafana 3000:3000 -n openfaas
184+
$ kubectl port-forward pod/grafana 3000:3000 -n openfaas
185185
```
186186

187+
If you're using Kubernetes 1.17 or older, use `deploy/grafana` instead of `pod/` in the command above.
188+
187189
After the service has been created open Grafana in your browser, login with username `admin` password `admin` and navigate to the pre-made OpenFaaS dashboard at:
188190

189191

translations/ja/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ Docker:
2929
## [Lab 1 - まずはOpenFaaSの準備](./lab1.md)
3030

3131
* 必要なものをインストール
32-
* Docker Swarmを使ってシングルノードのクラスタをセットアップ
3332
* Docker Hubのアカウントについて
3433
* OpenFaaS CLI
3534
* OpenFaaSをデプロイ
@@ -100,7 +99,7 @@ Docker:
10099

101100
## [Lab 10 - 応用編 - secretの使い方](./lab10.md)
102101
* issue-botでsecretを使うようにしよう
103-
* Swarmのsecretを作ろう
102+
* のsecretを作ろう
104103
* functionからsecretにアクセスしよう
105104

106105
[Lab 1](lab1.md) から順番に進めていくことができます。

0 commit comments

Comments
 (0)