Skip to content

Commit c1894f8

Browse files
authored
docs(providers): add info about Myra protection option and docker image (#5879)
1 parent e22ceab commit c1894f8

File tree

1 file changed

+32
-14
lines changed

1 file changed

+32
-14
lines changed

docs/tutorials/myra.md

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,32 @@ This guide provides quick instructions for setting up and testing the [Myra Exte
1212

1313
## Quick Installation
1414

15-
### 1. Build and Push the Docker Image
15+
### 1. Get the Docker Image
16+
17+
#### Pull from container registry
18+
19+
The image is published with each version to Github Container Registry under [external-dns-myrasec-webhook](https://github.com/Myra-Security-GmbH/external-dns-myrasec-webhook/pkgs/container/external-dns-myrasec-webhook).
20+
21+
```bash
22+
# Pull the image
23+
docker pull ghcr.io/myra-security-gmbh/external-dns-myrasec-webhook:<VERSION>
24+
25+
# For the sake of this tutorial, tag the image with "myra-webhook:latest"
26+
docker image tag ghcr.io/myra-security-gmbh/external-dns-myrasec-webhook:<VERSION> myra-webhook:latest
27+
28+
```
29+
30+
#### Build and Push the Docker Image
1631

1732
```bash
1833
# From the project root
1934
docker build -t myra-webhook:latest .
2035

2136
# Tag the image for your container registry
22-
docker tag myra-webhook:latest YOUR_REGISTRY/myra-webhook:latest
37+
docker tag myra-webhook:latest <YOUR_REGISTRY>/myra-webhook:latest
2338

2439
# Push to your container registry
25-
docker push YOUR_REGISTRY/myra-webhook:latest
40+
docker push <YOUR_REGISTRY>/myra-webhook:latest
2641
```
2742

2843
> **Important**: The image must be pushed to a container registry accessible by your Kubernetes cluster. Update the image reference in the deployment YAML file to match your registry path.
@@ -138,23 +153,26 @@ kubectl logs -l app=myra-externaldns -c myra-webhook | grep "Deleted DNS record"
138153

139154
The webhook can be configured through the ConfigMap:
140155

141-
| Parameter | Description | Default |
142-
|-----------|-------------|---------|
143-
| `dry-run` | Run in dry-run mode without making actual changes | `"false"` |
144-
| `environment` | Environment name (affects private IP handling) | `"prod"` |
145-
| `log-level` | Logging level (debug, info, warn, error) | `"debug"` |
146-
| `ttl` | Default TTL for DNS records | `"300"` |
147-
| `webhook-listen-address` | Address and port for the webhook server | `":8080"` |
156+
| Parameter | Description | Default |
157+
| ------------------------ | ------------------------------------------------- | --------- |
158+
| `disable-protection` | Disabled Myra protection for DNS records | `"false"` |
159+
| `dry-run` | Run in dry-run mode without making actual changes | `"false"` |
160+
| `environment` | Environment name (affects private IP handling) | `"prod"` |
161+
| `log-level` | Logging level (debug, info, warn, error) | `"debug"` |
162+
| `ttl` | Default TTL for DNS records | `"300"` |
163+
| `webhook-listen-address` | Address and port for the webhook server | `":8080"` |
148164

149165
## Troubleshooting
150166

151167
### Common Issues
152168

153169
1. **Webhook not receiving requests**
170+
154171
- Ensure the `webhook-provider-url` in the external-dns args is correct
155172
- Check network connectivity between containers
156173

157174
2. **DNS records not being created**
175+
158176
- Verify MyraSec API credentials are correct
159177
- Check if the domain filter is properly configured
160178
- Look for error messages in the webhook and external-dns logs
@@ -185,14 +203,14 @@ kind: ConfigMap
185203
metadata:
186204
name: myra-externaldns-config
187205
data:
188-
environment: "prod" # Can be "prod", "staging", "dev", etc.
206+
environment: "prod" # Can be "prod", "staging", "dev", etc.
189207
```
190208
191209
The environment setting affects how the webhook handles certain operations:
192210
193-
| Environment | Behavior |
194-
|-------------|----------|
195-
| `prod`, `production`, `staging` | Strict mode: Skips private IP records, enforces stricter validation |
211+
| Environment | Behavior |
212+
| ---------------------------------- | ----------------------------------------------------------------------- |
213+
| `prod`, `production`, `staging` | Strict mode: Skips private IP records, enforces stricter validation |
196214
| `dev`, `development`, `test`, etc. | Development mode: Allows private IP records, more permissive validation |
197215

198216
To modify the environment:

0 commit comments

Comments
 (0)