Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pragkent/alidns-webhook

Cert manager acme dns01 webhook provider for alidns
https://github.com/pragkent/alidns-webhook

alidns alidns-provider-solver cert-manager cert-manager-webhook letsencrypt

Last synced: about 2 months ago
JSON representation

Cert manager acme dns01 webhook provider for alidns

Awesome Lists containing this project

README

        

# alidns-webhook

Cert-manager ACME DNS webhook provider for alidns.

## Install

### Install cert manager
Please find document here: https://cert-manager.io/docs/installation/kubernetes/

### Install webhook (Cert manager v0.11 and above)
1. Install alidns-webhook

```bash
# Install alidns-webhook to cert-manager namespace.
kubectl apply -f https://raw.githubusercontent.com/pragkent/alidns-webhook/master/deploy/bundle.yaml
```

2. Create secret contains alidns credentials
```yaml
apiVersion: v1
kind: Secret
metadata:
name: alidns-secret
namespace: cert-manager
data:
access-key: YOUR_ACCESS_KEY
secret-key: YOUR_SECRET_KEY

```

3. Example Issuer
```yaml
apiVersion: cert-manager.io/v1alpha2
kind: ClusterIssuer
metadata:
name: letsencrypt-staging
spec:
acme:
# Change to your letsencrypt email
email: [email protected]
server: https://acme-staging-v02.api.letsencrypt.org/directory
privateKeySecretRef:
name: letsencrypt-staging-account-key
solvers:
- dns01:
webhook:
groupName: acme.yourcompany.com
solverName: alidns
config:
region: ""
accessKeySecretRef:
name: alidns-secret
key: access-key
secretKeySecretRef:
name: alidns-secret
key: secret-key
```

4. Issue a certificate
```yaml
apiVersion: cert-manager.io/v1alpha2
kind: Certificate
metadata:
name: example-tls
spec:
secretName: example-com-tls
commonName: example.com
dnsNames:
- example.com
- "*.example.com"
issuerRef:
name: letsencrypt-staging
kind: ClusterIssuer
```

### Install webhook (Cert manager prior to v0.11)
1. Install alidns-webhook

```bash
# Install alidns-webhook to cert-manager namespace.
kubectl apply -f https://raw.githubusercontent.com/pragkent/alidns-webhook/master/deploy/legacy.yaml
```

2. Create secret contains alidns credentials
```yaml
apiVersion: v1
kind: Secret
metadata:
name: alidns-secret
namespace: cert-manager
data:
access-key: YOUR_ACCESS_KEY
secret-key: YOUR_SECRET_KEY

```

3. Example Issuer
```yaml
apiVersion: certmanager.k8s.io/v1alpha1
kind: ClusterIssuer
metadata:
name: letsencrypt-staging
spec:
acme:
email: [email protected]
server: https://acme-staging-v02.api.letsencrypt.org/directory
privateKeySecretRef:
name: letsencrypt-staging-account-key
solvers:
- dns01:
webhook:
groupName: acme.yourcompany.com
solverName: alidns
config:
region: ""
accessKeySecretRef:
name: alidns-secret
key: access-key
secretKeySecretRef:
name: alidns-secret
key: secret-key
```

4. Issue a certificate
```yaml
apiVersion: certmanager.k8s.io/v1alpha1
kind: Certificate
metadata:
name: example-tls
spec:
secretName: example-com-tls
commonName: example.com
dnsNames:
- example.com
- "*.example.com"
issuerRef:
name: letsencrypt-staging
kind: ClusterIssuer
```

## Development
### Running the test suite

1. Edit `testdata/alidns/alidns-secret.yaml` and `testdata/alidns/config.json`.

2. Run test suites:

```bash
$ ./scripts/fetch-test-binaries.sh
$ TEST_ZONE_NAME=example.com go test .
```