summaryrefslogtreecommitdiffstats
path: root/client
diff options
context:
space:
mode:
authorKristian Aune <kraune@verizonmedia.com>2022-12-09 14:59:54 +0100
committerKristian Aune <kraune@verizonmedia.com>2022-12-09 14:59:54 +0100
commit68be1cde98f39ce9f1287af6fd0c97908317f578 (patch)
treebffd13f21d7e46dcf54bac69c3b8d348ac026125 /client
parent0f845e25cb7f0f4c91002a03b4c4c679cbb833e0 (diff)
Clarify, add link
Diffstat (limited to 'client')
-rw-r--r--client/go/README.md3
-rw-r--r--client/go/cmd/api_key.go8
-rw-r--r--client/go/cmd/cert.go8
3 files changed, 13 insertions, 6 deletions
diff --git a/client/go/README.md b/client/go/README.md
index b3633e697aa..487c3cc50ad 100644
--- a/client/go/README.md
+++ b/client/go/README.md
@@ -1,4 +1,5 @@
<!-- Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. -->
+
The command-line tool for Vespa.ai.
Use it on Vespa instances running locally, remotely or in the cloud.
@@ -6,3 +7,5 @@ Prefer web service API's to this in production.
See [Vespa documentation](https://docs.vespa.ai) and [getting started with Vespa
CLI](https://docs.vespa.ai/en/vespa-cli.html).
+
+Run `make` to build and test - make sure to use go 1.18 or higher.
diff --git a/client/go/cmd/api_key.go b/client/go/cmd/api_key.go
index a7d405963b0..0b55b43a756 100644
--- a/client/go/cmd/api_key.go
+++ b/client/go/cmd/api_key.go
@@ -18,8 +18,8 @@ func newAPIKeyCmd(cli *CLI) *cobra.Command {
var overwriteKey bool
cmd := &cobra.Command{
Use: "api-key",
- Short: "Create a new user API key for authentication with Vespa Cloud",
- Long: `Create a new user API key for authentication with Vespa Cloud.
+ Short: "Create a new user API key for control-plane authentication with Vespa Cloud",
+ Long: `Create a new user API key for control-plane authentication with Vespa Cloud.
The API key will be stored in the Vespa CLI home directory
(see 'vespa help config'). Other commands will then automatically load the API
@@ -37,7 +37,9 @@ Example of loading the key from a custom path:
export VESPA_CLI_API_KEY_FILE=/path/to/api-key
Note that when overriding API key through environment variables, that key will
-always be used. It's not possible to specify a tenant-specific key.`,
+always be used. It's not possible to specify a tenant-specific key.
+
+Read more in https://cloud.vespa.ai/en/security/guide`,
Example: "$ vespa auth api-key -a my-tenant.my-app.my-instance",
DisableAutoGenTag: true,
SilenceUsage: true,
diff --git a/client/go/cmd/cert.go b/client/go/cmd/cert.go
index 3b16ec4d342..e1907737105 100644
--- a/client/go/cmd/cert.go
+++ b/client/go/cmd/cert.go
@@ -23,8 +23,8 @@ func newCertCmd(cli *CLI) *cobra.Command {
)
cmd := &cobra.Command{
Use: "cert",
- Short: "Create a new private key and self-signed certificate for Vespa Cloud deployment",
- Long: `Create a new private key and self-signed certificate for Vespa Cloud deployment.
+ Short: "Create a new private key and self-signed certificate for data-plane access with Vespa Cloud",
+ Long: `Create a new private key and self-signed certificate for data-plane access with Vespa Cloud.
The private key and certificate will be stored in the Vespa CLI home directory
(see 'vespa help config'). Other commands will then automatically load the
@@ -46,7 +46,9 @@ Example of loading certificate and key from custom paths:
Note that when overriding key pair through environment variables, that key pair
will always be used for all applications. It's not possible to specify an
-application-specific key.`,
+application-specific key.
+
+Read more in https://cloud.vespa.ai/en/security/guide`,
Example: `$ vespa auth cert -a my-tenant.my-app.my-instance
$ vespa auth cert -a my-tenant.my-app.my-instance path/to/application/package`,
DisableAutoGenTag: true,