Skip to content

Commit 70c52b5

Browse files
committed
Add README
1 parent 421626b commit 70c52b5

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

Diff for: README.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# kubernetes-namespace
2+
3+
Instantly create, update and remove Kubernetes namespaces with [Serverless Components](https://github.com/serverless/components).
4+
5+
 
6+
7+
1. [Install](#1-install)
8+
2. [Create](#2-create)
9+
3. [Configure](#3-configure)
10+
4. [Deploy](#4-deploy)
11+
12+
 
13+
14+
### 1. Install
15+
16+
```console
17+
$ npm install -g serverless
18+
```
19+
20+
### 2. Create
21+
22+
Just create a `serverless.yml` file
23+
24+
```console
25+
$ touch serverless.yml
26+
```
27+
28+
Make sure that you have generated your [`Kubeconfig` file](https://rancher.com/docs/rancher/v2.x/en/cluster-admin/kubeconfig/) via `kubectl`.
29+
30+
### 3. Configure
31+
32+
```yml
33+
# serverless.yml
34+
35+
myKubernetesNamespace:
36+
component: '@serverless/kubernetes-namespace'
37+
inputs:
38+
kubeConfigPath: ../kubeconfig # default is `~/.kube/config`
39+
name: 'default' # default is `'default'`
40+
```
41+
42+
### 4. Deploy
43+
44+
```console
45+
$ serverless
46+
```
47+
48+
### New to Components?
49+
50+
Checkout the [Serverless Components](https://github.com/serverless/components) repo for more information.

0 commit comments

Comments
 (0)