@dmgnr/kuber 1.1.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -0
- package/dist/index.js +85 -85
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -67,6 +67,9 @@ bun run index.ts start
|
|
|
67
67
|
bun run index.ts stop
|
|
68
68
|
bun run index.ts restart
|
|
69
69
|
bun run index.ts db ls
|
|
70
|
+
bun run index.ts s3 ls
|
|
71
|
+
bun run index.ts s3 creds app
|
|
72
|
+
bun run index.ts s3 ui app
|
|
70
73
|
```
|
|
71
74
|
|
|
72
75
|
All commands accept `--config` to use a configuration file other than
|
|
@@ -102,6 +105,9 @@ For a permanent setup, write the generated script to a file and source it from y
|
|
|
102
105
|
- `exec <deployment> <command...>`: execute a command inside a running deployment pod
|
|
103
106
|
- `db ls`: list managed Postgres claims declared in the current Compose file
|
|
104
107
|
- `db creds <service>`: print the generated connection details for a managed Postgres claim
|
|
108
|
+
- `s3 ls`: list managed S3 claims declared in the current Compose file
|
|
109
|
+
- `s3 creds <service>`: print all generated S3 environment variables for a service
|
|
110
|
+
- `s3 ui <service>`: print the Garage UI object-browser URL for a service bucket
|
|
105
111
|
|
|
106
112
|
## Configuration
|
|
107
113
|
|
|
@@ -255,6 +261,18 @@ The Garage operator generates the credentials. `kuber` reads its generated Secre
|
|
|
255
261
|
|
|
256
262
|
One service can declare both `postgresql:...` and `s3:...`; all generated values are merged into the same service Secret. Managed Garage buckets and keys are retained by normal `down` and deleted by `down -f`.
|
|
257
263
|
|
|
264
|
+
Inspect a claim, print its generated credentials, or get its Garage UI URL:
|
|
265
|
+
|
|
266
|
+
```bash
|
|
267
|
+
kuber s3 ls
|
|
268
|
+
kuber s3 creds app
|
|
269
|
+
kuber s3 ui app
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
`s3 creds` prints `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`,
|
|
273
|
+
`AWS_ENDPOINT_URL_S3`, `AWS_REGION`, and `S3_BUCKET` as shell-style environment
|
|
274
|
+
assignments. `s3 ui` only prints the URL; it does not open a browser.
|
|
275
|
+
|
|
258
276
|
### Environment Files
|
|
259
277
|
|
|
260
278
|
`env_file` entries are read locally and turned into a Kubernetes `Secret` named `<service>-env`. Deployments then consume that secret through `envFrom`.
|