- Notifications
You must be signed in to change notification settings - Fork5
The metal-stack CLI for accessing the metal-api.
License
metal-stack/metalctl
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
metalctl is the command line client to access themetal-api.
Download locations:
curl -LO https://github.com/metal-stack/metalctl/releases/latest/download/metalctl-linux-amd64chmod +x metalctl-linux-amd64sudo mv metalctl-linux-amd64 /usr/local/bin/metalctl
For x86 based Macs:
curl -LO https://github.com/metal-stack/metalctl/releases/latest/download/metalctl-darwin-amd64chmod +x metalctl-darwin-amd64sudo mv metalctl-darwin-amd64 /usr/local/bin/metalctl
For Apple Silicon (M1) based Macs:
curl -LO https://github.com/metal-stack/metalctl/releases/latest/download/metalctl-darwin-arm64chmod +x metalctl-darwin-arm64sudo mv metalctl-darwin-arm64 /usr/local/bin/metalctl
curl -LO https://github.com/metal-stack/metalctl/releases/latest/download/metalctl-windows-amd64copy metalctl-windows-amd64 metalctl.exe
In order to keep your localmetalctl installation up to date, you can update the binary like this:
metalctl update checklatest version:v0.8.3 from:2020-08-13T11:55:14Zlocal version:v0.8.2 from:2020-08-12T09:27:39Zmetalctl is not up to datemetalctl updatedo# a download with progress bar starts and replaces the binary. If the binary has root permissions please executesudo metalctl updatedo# instead
makesudo ln -sf$(pwd)/bin/metalctl /usr/local/bin/metalctlSet up auto-completion formetalctl, e.g. add to your~/.bashrc:
source<(metalctl completion bash)
Set upmetalctl config, by first creating the config folder (mkdir -p ~/.metalctl), then set the values according to your installation in~/.metalctl/config.yaml:
---current:prodcontexts:prod:url:https://api.metal-stack.io/metalissuer_url:https://dex.metal-stack.io/dexclient_id:metal_clientclient_secret:456hmac:YOUR_HMAChmac_auth_type:THE_AUTH_TYPE_OF_YOUR_HMAC# Metal-Admin, Metal-Edit or Metal-View
Optional you can specifyissuer_type: generic if you use other issuers as Dex, e.g. Keycloak (this will request scopesopenid,profile,email):
contexts: prod: url: https://api.metal-stack.io/metal issuer_url: https://keycloak.somedomain.io issuer_type: generic client_id: my-client-id client_secret: my-secret
If you must specify special scopes for your issuer, you can usecustom_scopes:
contexts: prod: url: https://api.metal-stack.io/metal issuer_url: https://keycloak.somedomain.io custom_scopes: roles,openid,profile,email client_id: my-client-id client_secret: my-secret
Full documentation is generated out of the cobra command implementation with:
metalctl markdown
generated markdown ishere andhere
For MacOS users, running the tests might throw an error because tests are utilizinggo-mpatch in order to manipulate thetime.Now function. The patch allows testing with fixed timestamps.
Instead, MacOS users can utilize themake test-in-docker target to execute the tests.
About
The metal-stack CLI for accessing the metal-api.
Topics
Resources
License
Contributing
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.