README.md 882 Bytes
Newer Older
Hugo's avatar
readme    
Hugo committed
1
2
3
4
5
6
# Teapot

Teapot is a little webserver for maintenance and error pages.

## Deploy

Hugo's avatar
Hugo committed
7
8
9
```yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
Hugo's avatar
Hugo committed
10
namespace: ingress
Hugo's avatar
Hugo committed
11
12
resources:
  - https://git.indie.host/indiehost/tech/teapot.git
Hugo's avatar
readme    
Hugo committed
13
14
```

Hugo's avatar
Hugo committed
15
16
Add `--default-backend-service=$(POD_NAMESPACE)/teapot` to nginx ingress controller.

Hugo's avatar
readme    
Hugo committed
17
18
19
20
21
22
23
24
25
26
27
28
## Usage

### /maintenance

#### Query Params

- what
- info
- egg
- when
- email

Hugo's avatar
Hugo committed
29
30
31
32
33
34
35
36
37
38
39
40
#### Ingress example

```yaml
apiVersion: extensions/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/rewrite-target: /maintenance?what=RocketChat&when=17h&info=https://forum.indie.host/&egg=https://www.youtube.com/watch?v=dQw4w9WgXcQ&email=1

```

### /
Hugo's avatar
readme    
Hugo committed
41
42
43
44

#### Query Params

- msg
Hugo's avatar
Hugo committed
45

Hugo's avatar
Hugo committed
46
47
#### Ingress

Hugo's avatar
Hugo committed
48
49
50
51
52
53

```yaml
apiVersion: extensions/v1beta1
kind: Ingress
metadata:
  annotations:
Hugo's avatar
Hugo committed
54
55
    nginx.ingress.kubernetes.io/rewrite-target: /?msg=Nooon!
```