Skip to content

Commit

Permalink
Merge pull request #32 from dchudik/master
Browse files Browse the repository at this point in the history
Updated README. Fix install instruction. Added detailed instruction for developers.
  • Loading branch information
6opo9a authored Dec 18, 2023
2 parents 48a7f49 + 6e0047a commit 6e8398a
Showing 1 changed file with 14 additions and 10 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,28 @@ Cert-manager ACME DNS webhook provider for Selectel.

## Installing

To install with helm, run:
To install with helm in namespace: cert-manager, run:

```bash
$ helm repo add selectel https://selectel.github.io/cert-manager-webhook-selectel
$ helm repo update
$ helm install --name cert-manager-webhook-selectel selectel/cert-manager-webhook-selectel
$ helm install cert-manager-webhook-selectel selectel/cert-manager-webhook-selectel -n cert-manager
```

OR

```bash
$ git clone https://github.com/selectel/cert-manager-webhook-selectel.git
$ cd cert-manager-webhook-selectel/deploy/cert-manager-webhook-selectel
$ helm install --name cert-manager-webhook-selectel .
$ helm install cert-manager-webhook-selectel . -n cert-manager
```

Without helm, run:
<!-- Without helm, run: -->

```bash
<!-- ```bash
$ make rendered-manifest.yaml
$ kubectl apply -f _out/rendered-manifest.yaml
```
``` -->

### Issuer/ClusterIssuer

Expand All @@ -38,6 +38,7 @@ apiVersion: v1
kind: Secret
metadata:
name: selectel-api-key
namespace: cert-manager
type: Opaque
stringData:
token: APITOKEN_FROM_MY_SELECTEL_RU
Expand All @@ -46,7 +47,7 @@ apiVersion: cert-manager.io/v1
kind: Issuer
metadata:
name: letsencrypt-staging
namespace: default
namespace: cert-manager
spec:
acme:
server: https://acme-staging-v02.api.letsencrypt.org/directory
Expand Down Expand Up @@ -78,7 +79,7 @@ apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
name: sel-letsencrypt-crt
namespace: default
namespace: cert-manager
spec:
secretName: example-com-tls
commonName: example.com
Expand All @@ -96,8 +97,11 @@ spec:
You can run the test suite with:
1. Go to `https://my.selectel.ru/profile/apikeys`, get one or create new api token
2. Fill in the appropriate values in `testdata/selectel/apikey.yml` and `testdata/selectel/config.json`
1. Go to `https://my.selectel.ru/profile/apikeys`, get one or create new api token.
2. Fill in the appropriate values in `testdata/selectel/apikey.yml` and `testdata/selectel/config.json`.
- Insert token `testdata/selectel/apikey.yml`.
- Check that `metadata.name` in `testdata/selectel/apikey.yml` equals value in `testdata/selectel/config.json` for key `apiKeySecretRef.name`.
- Check that key name in `testdata/selectel/apikey.yml` equals value in `testdata/selectel/config.json` for key `apiKeySecretRef.key`.

```bash
$ TEST_ZONE_NAME=example.com. make test
Expand Down

0 comments on commit 6e8398a

Please sign in to comment.