Skip to content

fix(docs): Add synopsis for bind apiservice #392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xrstf merged 1 commit into from
Nov 24, 2025
Merged

fix(docs): Add synopsis for bind apiservice #392

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions cli/pkg/kubectl/bind-apiservice/cmd/cmd.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,22 @@ var (
func New(streams genericclioptions.IOStreams) (*cobra.Command, error) {
opts := plugin.NewBindAPIServiceOptions(streams)
cmd := &cobra.Command{
Use: "apiservice https://<url-to-a-APIServiceExportRequest>|-f <file-to-a-APIBindingRequest>",
Short: "Bind to a remote API service",
Example: help.Examplesf(bindAPIServiceExampleUses, "kubectl bind"),
Use: "apiservice https://<url-to-a-APIServiceExportRequest>|-f <file-to-a-APIBindingRequest>",
Short: "Bind to a remote API service",
Long: help.Doc(`
Bind to a remote API service by creating an APIServiceExportRequest.

This command allows you to bind remote services into your cluster by either:

- Providing a URL to an APIServiceExportRequest resource
- Providing a file containing an APIServiceExportRequest manifest
- Using a template name to interactively create the binding

The command will authenticate with the remote service provider, create the necessary
APIServiceExportRequest, and deploy a konnector to establish the connection between
your cluster and the remote service.
`),
Example: fmt.Sprintf(bindAPIServiceExampleUses, "kubectl bind"),
SilenceUsage: true,
RunE: func(cmd *cobra.Command, args []string) error {
if err := logsv1.ValidateAndApply(opts.Logs, nil); err != nil {
Expand Down