Skip to content

Commit c11e23f

Browse files
johnmccabealexellis
authored andcommitted
Multiple top level headings unsupported
This commit updates the heading levels in the troubleshooting guide to avoid multiple top-level header declarations (MD-025). Signed-off-by: John McCabe <[email protected]>
1 parent 7cd4fe5 commit c11e23f

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

docs/deployment/troubleshooting.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -160,31 +160,31 @@ On certain Linux distributions the name `localhost` maps to an IPv6 alias meanin
160160

161161
3. Edit the `/etc/hosts` file on your machine and remove the IPv6 alias for localhost (this forces the use of IPv4)
162162

163-
# Troubleshooting Swarm or Kubernetes
163+
## Troubleshooting Swarm or Kubernetes
164164

165-
## Docker Swarm
165+
### Docker Swarm
166166

167-
### List all functions
167+
#### List all functions
168168

169169
```
170170
$ docker service ls
171171
```
172172

173173
You are looking for 1/1 for the replica count of each service listed.
174174

175-
### Find a function's logs
175+
#### Find a function's logs
176176

177177
```
178178
$ docker service logs --tail 100 FUNCTION
179179
```
180180

181-
### Find out if a function failed to start
181+
#### Find out if a function failed to start
182182

183183
```
184184
$ docker service ps --no-trunc=true FUNCTION
185185
```
186186

187-
### Stop and remove OpenFaaS
187+
#### Stop and remove OpenFaaS
188188

189189
```
190190
$ docker stack rm func
@@ -198,29 +198,29 @@ $ docker service ls -q | xargs docker service rm
198198

199199
*Use with caution*
200200

201-
## Kubernetes
201+
### Kubernetes
202202

203203
If you have deployed OpenFaaS to the recommended namespaces then functions are in the `openfaas-fn` namespace and the core services are in the `openfaas` namespace. The `-n` flag to `kubectl` sets the namespace to look at.
204204

205-
### List OpenFaaS services
205+
#### List OpenFaaS services
206206

207207
```
208208
$ kubectl get deploy -n openfaas
209209
```
210210

211-
### List all functions
211+
#### List all functions
212212

213213
```
214214
$ kubectl get deploy -n openfaas-fn
215215
```
216216

217-
### Find a function's logs
217+
#### Find a function's logs
218218

219219
```
220220
$ kubectl logs -n openfaas-fn deploy/FUNCTION_NAME
221221
```
222222

223-
### Find out if a function failed to start
223+
#### Find out if a function failed to start
224224

225225
```
226226
$ kubectl describe -n openfaas-fn deploy/FUNCTION_NAME
@@ -230,7 +230,7 @@ $ kubectl describe -n openfaas-fn deploy/FUNCTION_NAME
230230
$ kubectl get events --sort-by=.metadata.creationTimestamp -n openfaas-fn
231231
```
232232

233-
### Check logs of the core services
233+
#### Check logs of the core services
234234

235235
Check for any relevant events:
236236

@@ -240,37 +240,37 @@ $ kubectl get events --sort-by=.metadata.creationTimestamp -n openfaas
240240

241241
These instructions may differ depending on whether you are using faas-netes (default) or the OpenFaaS Operator
242242

243-
#### Get logs using faas-netes
243+
##### Get logs using faas-netes
244244

245245
```
246246
$ kubectl logs -n openfaas deploy/faas-netes
247247
$ kubectl logs -n openfaas deploy/gateway
248248
```
249249

250-
#### Check the queue-worker
250+
##### Check the queue-worker
251251

252252
```
253253
$ kubectl logs -n openfaas-fn deploy/queue-worker
254254
```
255255

256-
#### Get logs using OpenFaaS Operator
256+
##### Get logs using OpenFaaS Operator
257257

258258
```
259259
$ kubectl logs -n openfaas deploy/gateway -c operator
260260
$ kubectl logs -n openfaas deploy/gateway -c gateway
261261
```
262262

263-
### Remove the OpenFaaS deployment
263+
#### Remove the OpenFaaS deployment
264264

265265
From within the `faas-netes` folder:
266266

267267
```
268268
$ kubectl delete -f namespaces.yml,./yaml/
269269
```
270270

271-
# Watchdog
271+
## Watchdog
272272

273-
## Debug your function without deploying it
273+
### Debug your function without deploying it
274274

275275
Here's an example of how you can deploy a function without using an orchestrator and the API gateeway. It is especially useful for testing:
276276

@@ -286,7 +286,7 @@ Now you can access the function with one of the supported HTTP methods such as G
286286
$ curl -4 127.0.0.1:8081
287287
```
288288

289-
## Edit your function without rebuilding it
289+
### Edit your function without rebuilding it
290290

291291
You can bind-mount code straight into your function and work with it locally, until you are ready to re-build. This is a common flow with containers, but should be used sparingly.
292292

0 commit comments

Comments
 (0)