service-catalog-cli

README

Service Catalog CLI

This project is a command line interface (CLI) for interacting with Kubernetes Service Catalog resources.

The goal of the CLI is to provide an easy user interface for Service Catalog users to inspect and modify the state of the resources in the system.

Install

Bash

curl -sLO https://servicecatalogcli.blob.core.windows.net/cli/latest/$(uname -s)/$(uname -m)/svc-cat
chmod +x ./svc-cat
mv ./svc-cat /usr/local/bin/
svc-cat --version

Powershell

iwr 'https://servicecatalogcli.blob.core.windows.net/cli/latest/Windows/x86_64/svc-cat.exe' -UseBasicParsing -OutFile svc-cat.exe
mkdir -f ~\bin
$env:PATH += ";${pwd}\bin"
svc-cat --version

The snippet above adds a directory to your PATH for the current session only. You will need to find a permanent location for it and add it to your PATH.

Manual

1. Download the appropriate binary for your operating system:
   • MacOS: https://servicecatalogcli.blob.core.windows.net/cli/latest/Darwin/x86_64/svc-cat
   • Windows: https://servicecatalogcli.blob.core.windows.net/cli/latest/Windows/x86_64/svc-cat.exe
   • Linux: https://servicecatalogcli.blob.core.windows.net/cli/latest/Linux/x86_64/svc-cat
2. Make the binary executable.
3. Move the binary to a directory on your PATH.

Use

This CLI is called svc-cat on the command line. See below for a description of the commands that svc-cat offers.

Commands for ClusterServiceBrokers

To list all the brokers in the cluster:

svc-cat get brokers

To get the status of an individual broker:

svc-cat get broker <broker name>

Commands for ClusterServiceClasses

To get a list of all the ClusterServiceClasses in the cluster (i.e. the catalog):

svc-cat get classes

Commands for ClusterServicePlans

To get a list of all the ClusterServicePlans in the cluster (i.e. the catalog):

svc-cat get plans

Commands for ServiceInstances

To get a list of all the ServiceInstances in a namespace:

svc-cat get instances -n <namespace>

Commands for ServiceBindings

To get a list of all the ServiceBindings in a namespace:

svc-cat get bindings -n <namespace>

Contributing

For details on how to contribute to this project, please see contributing.md.

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.