You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: Add support for Private docker registries (#16837)
#### Summary
- [x] Depends on cloudquery/plugin-pb-go#248
I have verified that this functionality works with AWS ECR and with private Github container registry (ghcr.io) by clearing all local images from docker then running `go run main.go install src.yml` where the source was like this:
```
kind: source
spec:
name: "typeform"
registry: "docker"
# docker_registry_auth_token: ${DOCKER_AUTH}
# path: "012345678910.dkr.ecr.us-east-2.amazonaws.com/bernays:typeform"
path: "ghcr.io/bbernays/typeform:v1.3.0"
```
Copy file name to clipboardExpand all lines: website/pages/docs/reference/source-spec.md
+34Lines changed: 34 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -46,6 +46,40 @@ The name field may be used to uniquely identify a particular source configuratio
46
46
- `grpc`: mostly useful in debug mode when plugin is already running in a different terminal, CloudQuery will connect to the gRPC plugin server directly without spawning the process.
47
47
- `docker`: CloudQuery will run the plugin in a Docker container. This is most useful for plugins written in Python, as they do not support the `local`, `github` and `cloudquery` registries.
48
48
49
+
<!-- vale off -->
50
+
51
+
### docker_registry_auth_token
52
+
53
+
<!-- vale on -->
54
+
55
+
(`string`, optional, default: `""`, introduced in CLI `v5.7.0`)
56
+
57
+
Authentication token for private Docker container registries. This is required if the plugin is hosted in a private Docker container registry. The token should be a valid Docker registry token that can be used to pull the plugin image. This option is only relevant when `registry` is set to `docker`. The token is a base64 encoded string. Here is an example of how to generate the token:
Details about specific private container registries:
63
+
64
+
AWS ECR:
65
+
The username is `AWS` and you can get the password by running `aws ecr get-login-password --region <region>`. Replace `<region>` with the region where the ECR is located.
66
+
67
+
Generating the token for AWS ECR would look like this:
The username is `USERNAME` and you use a personal access token as the password. More information can be found [here](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic)
75
+
76
+
Generating the token for GitHub Container Registry would look like this:
0 commit comments