From aeedfd4dbd92025ce6131a2ee2c82bab517c5927 Mon Sep 17 00:00:00 2001 From: "Marlon (Esolitos) Saglia" Date: Mon, 12 Aug 2024 19:18:42 +0200 Subject: [PATCH] Revert "Update 'Vespa-CLI' reference documentation." (#3307) * Revert "Update 'Vespa-CLI' reference documentation." This reverts commit 2339f04161d6178f602ca2c77cc64e8dd7bb952f. * Revert "test workflows" This reverts commit efdb5cd0ad4871d767ffd7820e3b316254c438c8. * Revert "fix(CI): push changes to the documentation with PR" This reverts commit b692efd3b293d8f951ce78bb4761ea6be78649c4. --- .../actions/commit-updated-docs/action.yml | 62 ------------ .../workflows/auto-update-documentation.yml | 95 ++++++++++--------- en/reference/vespa-cli/vespa.md | 11 +-- en/reference/vespa-cli/vespa_auth_api-key.md | 7 +- en/reference/vespa-cli/vespa_clone.md | 5 +- en/reference/vespa-cli/vespa_config.md | 25 ++--- en/reference/vespa-cli/vespa_config_get.md | 1 + en/reference/vespa-cli/vespa_config_set.md | 3 +- en/reference/vespa-cli/vespa_config_unset.md | 1 + en/reference/vespa-cli/vespa_curl.md | 7 +- en/reference/vespa-cli/vespa_deploy.md | 23 ++--- en/reference/vespa-cli/vespa_destroy.md | 13 +-- en/reference/vespa-cli/vespa_document.md | 9 +- en/reference/vespa-cli/vespa_document_get.md | 10 +- en/reference/vespa-cli/vespa_document_put.md | 9 +- .../vespa-cli/vespa_document_remove.md | 9 +- .../vespa-cli/vespa_document_update.md | 9 +- en/reference/vespa-cli/vespa_feed.md | 5 +- en/reference/vespa-cli/vespa_fetch.md | 52 ---------- en/reference/vespa-cli/vespa_query.md | 12 +-- en/reference/vespa-cli/vespa_status.md | 6 +- en/reference/vespa-cli/vespa_status_deploy.md | 5 +- .../vespa-cli/vespa_status_deployment.md | 3 +- en/reference/vespa-cli/vespa_visit.md | 6 +- 24 files changed, 128 insertions(+), 260 deletions(-) delete mode 100644 .github/actions/commit-updated-docs/action.yml delete mode 100644 en/reference/vespa-cli/vespa_fetch.md diff --git a/.github/actions/commit-updated-docs/action.yml b/.github/actions/commit-updated-docs/action.yml deleted file mode 100644 index 35f883e9ff..0000000000 --- a/.github/actions/commit-updated-docs/action.yml +++ /dev/null @@ -1,62 +0,0 @@ -name: Commit via PR -description: Commit changes to the Vespa documentation via a PR. - -inputs: - commit-message: - description: "The commit message to use when updating the documentation." - required: true - files: - description: "The files to commit." - required: true - default: "." - push: - description: "Whether to push the changes to the repository, set to 'true' to push." - required: false - default: "false" - -runs: - using: "composite" - steps: - - name: Setup git - shell: bash - id: git-setup - run: | - git config --global user.email "bot+actions@vespa.ai" - git config --global user.name "${{ github.actor}}" - - # Find a suitable branch name for the PR. - PR_BRANCH_NAME="update-docs-$(date +%s)" - echo "branch=$PR_BRANCH_NAME" >> $GITHUB_OUTPUT - - - name: Commit - shell: bash - env: - PR_BRANCH_NAME: ${{ steps.git-setup.outputs.branch }} - run: | - git pull --rebase --autostash --quiet - git add ${{ inputs.files }} - git commit -m "${{ inputs.commit-message }}" - - - name: Create PR - shell: bash - id: pr - if: ${{ inputs.push == 'true' }} - env: - GH_TOKEN: ${{ github.token }} - PR_BRANCH_NAME: ${{ steps.git-setup.outputs.branch }} - run: | - git checkout -b "${PR_BRANCH_NAME}" - git push --set-upstream origin "${PR_BRANCH_NAME}" - - PR_URL=$(gh pr create --base master --head "${PR_BRANCH_NAME}" \ - --title "${{ inputs.commit-message }} MERGEOK" \ - --body "This PR was created by a GitHub Action.") - - echo "pr-url=${PR_URL}" >> $GITHUB_OUTPUT - - # Allow some time for the "Merge Stop Enforcer" to run. - # This is a workaround as the 'Auto-Merge' feature is not set up. - sleep 15 - - # Merge the PR with a rebase to ensure a clean history. - gh pr merge --rebase "${PR_URL}" diff --git a/.github/workflows/auto-update-documentation.yml b/.github/workflows/auto-update-documentation.yml index 760fe8641e..d922b1ef18 100644 --- a/.github/workflows/auto-update-documentation.yml +++ b/.github/workflows/auto-update-documentation.yml @@ -9,8 +9,10 @@ on: schedule: - cron: "0 0 * * *" - push: - branches: [push-via-pr] # Test the workflow by pushing to this branch + repository_dispatch: + types: + - update-vespa-version + - update-vespa-cli-doc permissions: contents: write @@ -22,10 +24,6 @@ defaults: # Ref: https://docs.github.com/en/actions/writing-workflows/workflow-syntax-for-github-actions#defaultsrunshell shell: bash -# Limit concurrency to better handle commit and push operations. -concurrency: - group: ${{ github.workflow }}-${{ github.ref }} - jobs: update-vespa-version: # @@ -33,9 +31,6 @@ jobs: # runs-on: ubuntu-24.04 - concurrency: - group: docs-update - steps: - uses: actions/checkout@v4 @@ -44,8 +39,7 @@ jobs: sudo apt-get update sudo apt-get install -y xq - - name: Update Vespa version - id: update-docs + - name: Get Latest Vespa version env: ENABLE_PUSH: ${{ contains(fromJSON('["workflow_dispatch", "schedule"]'), github.event_name) && github.ref_name == 'master' }} run: | @@ -53,22 +47,25 @@ jobs: xq -x '/metadata/versioning/latest') echo "Vespa version: $VESPA_VERSION" - echo "version=$VESPA_VERSION" >> $GITHUB_OUTPUT - # Update the Vespa version in the documentation configuration file. sed -i'' "s/\(vespa_version:\) \"[0-9\.]*\"/\1 \"${VESPA_VERSION}\"/" _config.yml - git diff - echo "has-changes=$(git status --short | wc -l)" >> $GITHUB_OUTPUT - - name: Commit changes - if: ${{ steps.update-docs.outputs.has-changes != '0' }} - uses: ./.github/actions/commit-updated-docs - with: - commit-message: "Update Vespa version to ${{ steps.vespa-metadata.outputs.version }}." - files: _config.yml - # push: ${{ env.ENABLE_PUSH == 'true' }} - push: "true" + # Check if there are changes to commit. + if [[ -n "$(git status --porcelain)" ]]; then + echo "Updating Vespa version in documentation to ${VESPA_VERSION}" >> $GITHUB_STEP_SUMMARY + git config --global user.email "bot+actions@vespa.ai" + git config --global user.name "${{ github.actor}}" + + git add _config.yml + git commit -m "Update Vespa-version to ${VESPA_VERSION}. MERGEOK" + git pull --rebase + + # Only push if the event is a push and the branch is the default branch. + if [[ "${{ env.ENABLE_PUSH }}" == "true" ]]; then + git push + fi + fi update-vespa-cli-doc: # @@ -80,9 +77,6 @@ jobs: VESPA_CLI_DOC_DIR: en/reference/vespa-cli ENABLE_PUSH: ${{ contains(fromJSON('["workflow_dispatch", "schedule"]'), github.event_name) && github.ref_name == 'master' }} - concurrency: - group: docs-update - steps: - uses: actions/checkout@v4 @@ -90,7 +84,6 @@ jobs: uses: vespa-engine/setup-vespa-cli-action@v1 - name: Generate Vespa CLI Documentation - id: update-docs working-directory: ${{ env.VESPA_CLI_DOC_DIR }} run: | vespa gendoc . @@ -109,15 +102,21 @@ jobs: sed -i'' 's#\(https://[a-z.]*vespa.ai/[^[:space:]]*\)#[\1](\1)#g' *.md git diff - echo "has-changes=$(git status --short | wc -l)" >> $GITHUB_OUTPUT - - name: Commit changes - if: ${{ steps.update-docs.outputs.has-changes != '0' }} - uses: ./.github/actions/commit-updated-docs - with: - commit-message: "Update 'Vespa-CLI' reference documentation." - files: ${{ env.VESPA_CLI_DOC_DIR }} - push: "true" + # Check if there are changes to commit. + if [[ -n "$(git status --short)" ]]; then + echo "Updating Vespa CLI reference documentation" >> $GITHUB_STEP_SUMMARY + git config --global user.email "bot+actions@vespa.ai" + git config --global user.name "${{ github.actor}}" + + git add vespa*.md + git commit -m "Update 'Vespa-CLI' reference documentation. MERGEOK" + git pull --rebase + + if [[ "${{ env.ENABLE_PUSH }}" == "true" ]]; then + git push + fi + fi update-metric-reference: # @@ -129,9 +128,6 @@ jobs: env: ENABLE_PUSH: ${{ contains(fromJSON('["workflow_dispatch", "schedule"]'), github.event_name) && github.ref_name == 'master' }} - concurrency: - group: docs-update - steps: - uses: actions/checkout@v4 @@ -152,8 +148,7 @@ jobs: echo "Using version: $VESPA_VERSION" echo "version=$VESPA_VERSION" >> $GITHUB_OUTPUT - - name: Update Metric Reference - id: update-docs + - name: Update to latest env: VESPA_VERSION: ${{ steps.vespa-metadata.outputs.version }} run: | @@ -162,10 +157,16 @@ jobs: git diff - - name: Commit changes - if: ${{ steps.update-docs.outputs.has-changes != '0' }} - uses: ./.github/actions/commit-updated-docs - with: - commit-message: "Update 'Metric' reference documentation." - files: "en/reference/*-metrics-reference.html" - push: "true" + if [[ -n "$(git status --short en/reference/*-metrics-reference.html)" ]]; then + echo "Updating metric reference" >> $GITHUB_STEP_SUMMARY + git config --global user.email "bot+actions@vespa.ai" + git config --global user.name "${{ github.actor}}" + + git add en/reference/*-metrics-reference.html + git commit -m "Update 'Metric' reference documentation. MERGEOK" + git pull --rebase + + if [[ "${{ env.ENABLE_PUSH }}" == "true" ]]; then + git push + fi + fi diff --git a/en/reference/vespa-cli/vespa.md b/en/reference/vespa-cli/vespa.md index bc4c372806..69032c083d 100644 --- a/en/reference/vespa-cli/vespa.md +++ b/en/reference/vespa-cli/vespa.md @@ -13,12 +13,7 @@ The command-line tool for Vespa.ai. Use it on Vespa instances running locally, remotely or in Vespa Cloud. -To get started, see the following quick start guides: - -- Local Vespa instance: [https://docs.vespa.ai/en/vespa-quick-start.html](https://docs.vespa.ai/en/vespa-quick-start.html) -- Vespa Cloud: [https://cloud.vespa.ai/en/getting-started](https://cloud.vespa.ai/en/getting-started) - -The complete Vespa documentation is available at https://docs.vespa.ai. +Vespa documentation: https://docs.vespa.ai For detailed description of flags and configuration, see 'vespa help config'. @@ -45,13 +40,13 @@ vespa [flags] * [vespa activate](vespa_activate.html) - Activate (deploy) a previously prepared application package * [vespa auth](vespa_auth.html) - Manage Vespa Cloud credentials * [vespa clone](vespa_clone.html) - Create files and directory structure from a Vespa sample application +* [vespa completion](vespa_completion.html) - Generate the autocompletion script for the specified shell * [vespa config](vespa_config.html) - Manage persistent values for global flags * [vespa curl](vespa_curl.html) - Access Vespa directly using curl * [vespa deploy](vespa_deploy.html) - Deploy (prepare and activate) an application package * [vespa destroy](vespa_destroy.html) - Remove a deployed Vespa application and its data * [vespa document](vespa_document.html) - Issue a single document operation to Vespa * [vespa feed](vespa_feed.html) - Feed multiple document operations to Vespa -* [vespa fetch](vespa_fetch.html) - Download a deployed application package * [vespa log](vespa_log.html) - Show the Vespa log * [vespa prepare](vespa_prepare.html) - Prepare an application package for activation * [vespa prod](vespa_prod.html) - Deploy an application package to production in Vespa Cloud @@ -59,5 +54,5 @@ vespa [flags] * [vespa status](vespa_status.html) - Show Vespa endpoints and status * [vespa test](vespa_test.html) - Run a test suite, or a single test * [vespa version](vespa_version.html) - Show current CLI version and check for updates -* [vespa visit](vespa_visit.html) - Retrieve and print all documents from Vespa +* [vespa visit](vespa_visit.html) - Fetch and print all documents from Vespa diff --git a/en/reference/vespa-cli/vespa_auth_api-key.md b/en/reference/vespa-cli/vespa_auth_api-key.md index 045e7c5aa7..06c2b2613e 100644 --- a/en/reference/vespa-cli/vespa_auth_api-key.md +++ b/en/reference/vespa-cli/vespa_auth_api-key.md @@ -11,9 +11,8 @@ Create a new developer key for headless authentication with Vespa Cloud control Create a new developer key for headless authentication with Vespa Cloud control plane -A developer key is a tenant-wide secret, intended for headless communication -with the Vespa Cloud control plane. For example when deploying from a continuous -integration system. +A developer key is intended for headless communication with the Vespa Cloud +control plane. For example when deploying from a continuous integration system. The developer key will be stored in the Vespa CLI home directory (see 'vespa help config'). Other commands will then automatically load the developer @@ -34,7 +33,7 @@ Note that when overriding the developer key through environment variables, that key will always be used. It's not possible to specify a tenant-specific key through the environment. -See [https://cloud.vespa.ai/en/security/guide](https://cloud.vespa.ai/en/security/guide) for more details about developer keys. +Read more in [https://cloud.vespa.ai/en/security/guide](https://cloud.vespa.ai/en/security/guide) ``` vespa auth api-key [flags] diff --git a/en/reference/vespa-cli/vespa_clone.md b/en/reference/vespa-cli/vespa_clone.md index 4184a554c5..9ab5a0ff93 100644 --- a/en/reference/vespa-cli/vespa_clone.md +++ b/en/reference/vespa-cli/vespa_clone.md @@ -9,13 +9,14 @@ Create files and directory structure from a Vespa sample application ### Synopsis -Create files and directory structure from a Vespa sample application. +Create files and directory structure from a Vespa sample application +from a sample application. Sample applications are downloaded from https://github.com/vespa-engine/sample-apps. By default sample applications are cached in the user's cache directory. This -directory can be overriden by setting the VESPA_CLI_CACHE_DIR environment +directory can be overridden by setting the VESPA_CLI_CACHE_DIR environment variable. ``` diff --git a/en/reference/vespa-cli/vespa_config.md b/en/reference/vespa-cli/vespa_config.md index 25a9852031..4bb03bc61b 100644 --- a/en/reference/vespa-cli/vespa_config.md +++ b/en/reference/vespa-cli/vespa_config.md @@ -11,9 +11,9 @@ Manage persistent values for global flags Manage persistent values for global flags. -This command allows setting persistent values for the global flags found in -Vespa CLI. On future invocations the flag can then be omitted as it is read -from the config file instead. +This command allows setting persistent values for global flags. On future +invocations the flag can then be omitted as it is read from the config file +instead. Configuration is written to $HOME/.vespa by default. This path can be overridden by setting the VESPA_CLI_HOME environment variable. @@ -36,16 +36,16 @@ The following global flags/options can be configured: application Specifies the application ID to manage. It has three parts, separated by -dots, with the third part being optional. If the third part is omitted it -defaults to "default". This is only relevant for the "cloud" and "hosted" -targets. See [https://cloud.vespa.ai/en/tenant-apps-instances](https://cloud.vespa.ai/en/tenant-apps-instances) for more details. -This has no default value. Examples: tenant1.app1, tenant1.app1.instance1 +dots, with the third part being optional. If the part is omitted it defaults to +"default". This is only relevant for the "cloud" and "hosted" targets. See +[https://cloud.vespa.ai/en/tenant-apps-instances](https://cloud.vespa.ai/en/tenant-apps-instances) for more details. This has no +default value. Examples: tenant1.app1, tenant1.app1.instance1 cluster Specifies the container cluster to manage. If left empty (default) and the application has only one container cluster, that cluster is chosen -automatically. When an application has multiple cluster this must specify a +automatically. When an application has multiple cluster this must be set a valid cluster name, as specified in services.xml. See [https://docs.vespa.ai/en/reference/services-container.html](https://docs.vespa.ai/en/reference/services-container.html) for more details. @@ -58,9 +58,9 @@ colors if supported by the terminal, "never" completely disables colors and instance Specifies the instance of the application to manage. When specified, this takes -precedence over the instance specified as part of the 'application' option. -This has no default value and is only relevant for the "cloud" and "hosted" -targets. Example: instance2 +precedence over the instance specified as part of application. This has no +default value and is only relevant for the "cloud" and "hosted" targets. +Example: instance2 quiet @@ -85,7 +85,7 @@ e.g. vespa deploy or vespa query. Possible values are: Authentication is configured automatically for the cloud and hosted targets. To set a custom private key and certificate, e.g. for use with a self-hosted Vespa -installation configured with mTLS, see the documentation of 'vespa auth cert'. +installation using mTLS, see the documentation of 'vespa cert'. zone @@ -94,6 +94,7 @@ This is only relevant for cloud and hosted targets and defaults to a dev zone. See [https://cloud.vespa.ai/en/reference/zones](https://cloud.vespa.ai/en/reference/zones) for available zones. Examples: dev.aws-us-east-1c, dev.gcp-us-central1-f, perf.aws-us-east-1c + ``` vespa config [flags] ``` diff --git a/en/reference/vespa-cli/vespa_config_get.md b/en/reference/vespa-cli/vespa_config_get.md index 3e7831e427..9101ea9c03 100644 --- a/en/reference/vespa-cli/vespa_config_get.md +++ b/en/reference/vespa-cli/vespa_config_get.md @@ -26,6 +26,7 @@ vespa config get [option-name] [flags] $ vespa config get $ vespa config get target $ vespa config get --local + ``` ### Options diff --git a/en/reference/vespa-cli/vespa_config_set.md b/en/reference/vespa-cli/vespa_config_set.md index 089845dd09..f0dee951ad 100644 --- a/en/reference/vespa-cli/vespa_config_set.md +++ b/en/reference/vespa-cli/vespa_config_set.md @@ -27,7 +27,8 @@ $ vespa config set application my-tenant.my-application.my-instance $ vespa config set instance other-instance # Set an option in local configuration, for the current application only -$ vespa config set --local zone perf.us-north-1 +$ vespa config set --local wait 600 + ``` ### Options diff --git a/en/reference/vespa-cli/vespa_config_unset.md b/en/reference/vespa-cli/vespa_config_unset.md index 688cb4a6e4..191fa4039e 100644 --- a/en/reference/vespa-cli/vespa_config_unset.md +++ b/en/reference/vespa-cli/vespa_config_unset.md @@ -26,6 +26,7 @@ $ vespa config unset target # Stop overriding application option in local config $ vespa config unset --local application + ``` ### Options diff --git a/en/reference/vespa-cli/vespa_curl.md b/en/reference/vespa-cli/vespa_curl.md index 9d40b626b1..10b1dd3e88 100644 --- a/en/reference/vespa-cli/vespa_curl.md +++ b/en/reference/vespa-cli/vespa_curl.md @@ -31,9 +31,10 @@ $ vespa curl -- -v --data-urlencode "yql=select * from music where album contain ### Options ``` - -n, --dry-run Print the curl command that would be executed - -h, --help help for curl - -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) + -n, --dry-run Print the curl command that would be executed + -h, --help help for curl + -s, --service string Which service to query. Must be "deploy" or "container" (default "container") + -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) ``` ### Options inherited from parent commands diff --git a/en/reference/vespa-cli/vespa_deploy.md b/en/reference/vespa-cli/vespa_deploy.md index c35fc146f2..5ed1e79456 100644 --- a/en/reference/vespa-cli/vespa_deploy.md +++ b/en/reference/vespa-cli/vespa_deploy.md @@ -11,22 +11,19 @@ Deploy (prepare and activate) an application package Deploy (prepare and activate) an application package. -An application package defines a deployable Vespa application. See -[https://docs.vespa.ai/en/reference/application-packages-reference.html](https://docs.vespa.ai/en/reference/application-packages-reference.html) for -details about the files contained in this package. - -To get started, 'vespa clone' can be used to download a sample application. - -This command deploys an application package. When deploy returns successfully -the application package has been validated and activated on config servers. The -process of applying it on individual nodes has started but may not have -completed. +When this returns successfully the application package has been validated +and activated on config servers. The process of applying it on individual nodes +has started but may not have completed. If application directory is not specified, it defaults to working directory. -In Vespa Cloud you may override the Vespa runtime version (--version) for your -deployment. This option should only be used if you have a reason for using a -specific version. By default Vespa Cloud chooses a suitable version for you. +When deploying to Vespa Cloud the system can be overridden by setting the +environment variable VESPA_CLI_CLOUD_SYSTEM. This is intended for internal use +only. + +In Vespa Cloud you may override the Vespa runtime version for your deployment. +This option should only be used if you have a reason for using a specific +version. By default Vespa Cloud chooses a suitable version for you. ``` diff --git a/en/reference/vespa-cli/vespa_destroy.md b/en/reference/vespa-cli/vespa_destroy.md index 784eabdb37..2d9a84f102 100644 --- a/en/reference/vespa-cli/vespa_destroy.md +++ b/en/reference/vespa-cli/vespa_destroy.md @@ -18,14 +18,15 @@ When run interactively, the command will prompt for confirmation before removing the application. When run non-interactively, the command will refuse to remove the application unless the --force option is given. -This command can only be used to remove non-production deployments, in Vespa -Cloud. See [https://cloud.vespa.ai/en/deleting-applications](https://cloud.vespa.ai/en/deleting-applications) for how to remove -production deployments. - -For other systems, destroy the application by removing the -containers in use by the application. For example: +This command can only be used to remove non-production deployments. See +[https://cloud.vespa.ai/en/deleting-applications](https://cloud.vespa.ai/en/deleting-applications) for how to remove +production deployments. This command can only be used for deployments to +Vespa Cloud, for other systems destroy an application by cleaning up +containers in use by the application, see e.g https://github.com/vespa-engine/sample-apps/tree/master/examples/operations/multinode-HA#clean-up-after-testing + + ``` vespa destroy [flags] ``` diff --git a/en/reference/vespa-cli/vespa_document.md b/en/reference/vespa-cli/vespa_document.md index e6f9cd45eb..96892a32ff 100644 --- a/en/reference/vespa-cli/vespa_document.md +++ b/en/reference/vespa-cli/vespa_document.md @@ -33,11 +33,10 @@ $ vespa document src/test/resources/A-Head-Full-of-Dreams.json ### Options ``` - --header strings Add a header to the HTTP request, on the format 'Header: Value'. This can be specified multiple times - -h, --help help for document - -T, --timeout int Timeout for the document request in seconds (default 60) - -v, --verbose Print the equivalent curl command for the document operation - -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) + -h, --help help for document + -T, --timeout int Timeout for the document request in seconds (default 60) + -v, --verbose Print the equivalent curl command for the document operation + -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) ``` ### Options inherited from parent commands diff --git a/en/reference/vespa-cli/vespa_document_get.md b/en/reference/vespa-cli/vespa_document_get.md index 6bd5423564..8c45548521 100644 --- a/en/reference/vespa-cli/vespa_document_get.md +++ b/en/reference/vespa-cli/vespa_document_get.md @@ -20,12 +20,10 @@ $ vespa document get id:mynamespace:music::a-head-full-of-dreams ### Options ``` - --field-set string Fields to include when reading document - --header strings Add a header to the HTTP request, on the format 'Header: Value'. This can be specified multiple times - -h, --help help for get - -T, --timeout int Timeout for the document request in seconds (default 60) - -v, --verbose Print the equivalent curl command for the document operation - -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) + -h, --help help for get + -T, --timeout int Timeout for the document request in seconds (default 60) + -v, --verbose Print the equivalent curl command for the document operation + -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) ``` ### Options inherited from parent commands diff --git a/en/reference/vespa-cli/vespa_document_put.md b/en/reference/vespa-cli/vespa_document_put.md index 92eaaa847f..cb32bc9443 100644 --- a/en/reference/vespa-cli/vespa_document_put.md +++ b/en/reference/vespa-cli/vespa_document_put.md @@ -27,11 +27,10 @@ $ vespa document put id:mynamespace:music::a-head-full-of-dreams src/test/resour ### Options ``` - --header strings Add a header to the HTTP request, on the format 'Header: Value'. This can be specified multiple times - -h, --help help for put - -T, --timeout int Timeout for the document request in seconds (default 60) - -v, --verbose Print the equivalent curl command for the document operation - -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) + -h, --help help for put + -T, --timeout int Timeout for the document request in seconds (default 60) + -v, --verbose Print the equivalent curl command for the document operation + -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) ``` ### Options inherited from parent commands diff --git a/en/reference/vespa-cli/vespa_document_remove.md b/en/reference/vespa-cli/vespa_document_remove.md index fd11f3d921..b2967b5d95 100644 --- a/en/reference/vespa-cli/vespa_document_remove.md +++ b/en/reference/vespa-cli/vespa_document_remove.md @@ -26,11 +26,10 @@ $ vespa document remove id:mynamespace:music::a-head-full-of-dreams ### Options ``` - --header strings Add a header to the HTTP request, on the format 'Header: Value'. This can be specified multiple times - -h, --help help for remove - -T, --timeout int Timeout for the document request in seconds (default 60) - -v, --verbose Print the equivalent curl command for the document operation - -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) + -h, --help help for remove + -T, --timeout int Timeout for the document request in seconds (default 60) + -v, --verbose Print the equivalent curl command for the document operation + -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) ``` ### Options inherited from parent commands diff --git a/en/reference/vespa-cli/vespa_document_update.md b/en/reference/vespa-cli/vespa_document_update.md index a739d506cc..2296953118 100644 --- a/en/reference/vespa-cli/vespa_document_update.md +++ b/en/reference/vespa-cli/vespa_document_update.md @@ -26,11 +26,10 @@ $ vespa document update id:mynamespace:music::a-head-full-of-dreams src/test/res ### Options ``` - --header strings Add a header to the HTTP request, on the format 'Header: Value'. This can be specified multiple times - -h, --help help for update - -T, --timeout int Timeout for the document request in seconds (default 60) - -v, --verbose Print the equivalent curl command for the document operation - -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) + -h, --help help for update + -T, --timeout int Timeout for the document request in seconds (default 60) + -v, --verbose Print the equivalent curl command for the document operation + -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) ``` ### Options inherited from parent commands diff --git a/en/reference/vespa-cli/vespa_feed.md b/en/reference/vespa-cli/vespa_feed.md index b0fb31a29f..6427c0470e 100644 --- a/en/reference/vespa-cli/vespa_feed.md +++ b/en/reference/vespa-cli/vespa_feed.md @@ -34,7 +34,7 @@ in a JSON format: - http.request.MBps: Request throughput measured in MB/s. This is the raw operation throughput, and not the network throughput, I.e. using compression does not affect this number. -- http.exception.count: Same as feeder.error.count. Present for compatiblity +- http.exception.count: Same as feeder.error.count. Present for compatibility with vespa-feed-client. - http.response.count: Number of HTTP responses received. - http.response.bytes: Number of bytes received. @@ -60,10 +60,9 @@ $ cat docs.jsonl | vespa feed - ### Options ``` - --compression string Whether to compress the document data when sending the HTTP request. Default is "auto", which compresses large documents. Must be "auto", "gzip" or "none" (default "auto") + --compression string Compression mode to use. Default is "auto" which compresses large documents. Must be "auto", "gzip" or "none" (default "auto") --connections int The number of connections to use (default 8) --deadline int Exit if this number of seconds elapse without any successful operations. 0 to disable (default 0) - --header strings Add a header to all HTTP requests, on the format 'Header: Value'. This can be specified multiple times -h, --help help for feed --progress int Print stats summary at given interval, in seconds. 0 to disable (default 0) --route string Target Vespa route for feed operations (default "default") diff --git a/en/reference/vespa-cli/vespa_fetch.md b/en/reference/vespa-cli/vespa_fetch.md deleted file mode 100644 index 5d8ed4a3a5..0000000000 --- a/en/reference/vespa-cli/vespa_fetch.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: vespa fetch -render_with_liquid: false ---- - -## vespa fetch - -Download a deployed application package - -### Synopsis - -Download a deployed application package. - -This command can be used to download an already deployed Vespa application -package. The package is written as a ZIP file to the given path, or current -directory if no path is given. - -``` -vespa fetch [path] [flags] -``` - -### Examples - -``` -$ vespa fetch -$ vespa fetch mydir/ -$ vespa fetch -t cloud mycloudapp.zip - -``` - -### Options - -``` - -h, --help help for fetch -``` - -### Options inherited from parent commands - -``` - -a, --application string The application to use (cloud only) - -C, --cluster string The container cluster to use. This is only required for applications with multiple clusters - -c, --color string Whether to use colors in output. Must be "auto", "never", or "always" (default "auto") - -i, --instance string The instance of the application to use (cloud only) - -q, --quiet Print only errors - -t, --target string The target platform to use. Must be "local", "cloud", "hosted" or an URL (default "local") - -z, --zone string The zone to use. This defaults to a dev zone (cloud only) -``` - -### SEE ALSO - -* [vespa](vespa.html) - The command-line tool for Vespa.ai - diff --git a/en/reference/vespa-cli/vespa_query.md b/en/reference/vespa-cli/vespa_query.md index 50ddf1fbda..bb2b43ddba 100644 --- a/en/reference/vespa-cli/vespa_query.md +++ b/en/reference/vespa-cli/vespa_query.md @@ -22,19 +22,15 @@ vespa query query-parameters [flags] ``` $ vespa query "yql=select * from music where album contains 'head'" hits=5 -$ vespa query --format=plain "yql=select * from music where album contains 'head'" hits=5 -$ vespa query --header="X-First-Name: Joe" "yql=select * from music where album contains 'head'" hits=5 ``` ### Options ``` - --format string Output format. Must be 'human' (human-readable) or 'plain' (no formatting) (default "human") - --header strings Add a header to the HTTP request, on the format 'Header: Value'. This can be specified multiple times - -h, --help help for query - -T, --timeout int Timeout for the query in seconds (default 10) - -v, --verbose Print the equivalent curl command for the query - -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) + -h, --help help for query + -T, --timeout int Timeout for the query in seconds (default 10) + -v, --verbose Print the equivalent curl command for the query + -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) ``` ### Options inherited from parent commands diff --git a/en/reference/vespa-cli/vespa_status.md b/en/reference/vespa-cli/vespa_status.md index b13ef9784c..0d8e88af55 100644 --- a/en/reference/vespa-cli/vespa_status.md +++ b/en/reference/vespa-cli/vespa_status.md @@ -24,15 +24,13 @@ vespa status [flags] $ vespa status $ vespa status --cluster mycluster $ vespa status --cluster mycluster --wait 600 -$ vepsa status --format plain --cluster mycluster ``` ### Options ``` - --format string Output format. Must be 'human' (human-readable) or 'plain' (cluster URL only) (default "human") - -h, --help help for status - -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) + -h, --help help for status + -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) ``` ### Options inherited from parent commands diff --git a/en/reference/vespa-cli/vespa_status_deploy.md b/en/reference/vespa-cli/vespa_status_deploy.md index 9bf51c56f4..b722f9c89f 100644 --- a/en/reference/vespa-cli/vespa_status_deploy.md +++ b/en/reference/vespa-cli/vespa_status_deploy.md @@ -20,9 +20,8 @@ $ vespa status deploy ### Options ``` - --format string Output format. Must be 'human' (human-readable text) or 'plain' (cluster URL only) (default "human") - -h, --help help for deploy - -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) + -h, --help help for deploy + -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) ``` ### Options inherited from parent commands diff --git a/en/reference/vespa-cli/vespa_status_deployment.md b/en/reference/vespa-cli/vespa_status_deployment.md index 9e903dfa15..4602265cc6 100644 --- a/en/reference/vespa-cli/vespa_status_deployment.md +++ b/en/reference/vespa-cli/vespa_status_deployment.md @@ -12,7 +12,7 @@ Show status of a Vespa deployment Show status of a Vespa deployment. This commands shows whether a Vespa deployment has converged on the latest run -(Vespa Cloud) or config generation (self-hosted). If an argument is given, + (Vespa Cloud) or config generation (self-hosted). If an argument is given, show the convergence status of that particular run or generation. @@ -43,7 +43,6 @@ $ vespa status deployment -t local [session-id] --wait 600 -a, --application string The application to use (cloud only) -C, --cluster string The container cluster to use. This is only required for applications with multiple clusters -c, --color string Whether to use colors in output. Must be "auto", "never", or "always" (default "auto") - --format string Output format. Must be 'human' (human-readable) or 'plain' (cluster URL only) (default "human") -i, --instance string The instance of the application to use (cloud only) -q, --quiet Print only errors -t, --target string The target platform to use. Must be "local", "cloud", "hosted" or an URL (default "local") diff --git a/en/reference/vespa-cli/vespa_visit.md b/en/reference/vespa-cli/vespa_visit.md index 92b4b9fbe6..d1873a6571 100644 --- a/en/reference/vespa-cli/vespa_visit.md +++ b/en/reference/vespa-cli/vespa_visit.md @@ -5,11 +5,11 @@ render_with_liquid: false ## vespa visit -Retrieve and print all documents from Vespa +Fetch and print all documents from Vespa ### Synopsis -Retrieve and print all documents from Vespa. +Fetch and print all documents from Vespa. By default prints each document received on its own line (JSONL format). @@ -36,7 +36,6 @@ $ vespa visit --field-set "[id]" # list document IDs --debug-mode Print debugging output --field-set string Which fieldset to ask for --from string Timestamp to visit from, in seconds - --header strings Add a header to the HTTP request, on the format 'Header: Value'. This can be specified multiple times -h, --help help for visit --json-lines Output documents as JSON lines (default true) --make-feed Output JSON array suitable for vespa-feeder @@ -45,7 +44,6 @@ $ vespa visit --field-set "[id]" # list document IDs --slice-id int The number of the slice this visit invocation should fetch (default -1) --slices int Split the document corpus into this number of independent slices (default -1) --to string Timestamp to visit up to, in seconds - -v, --verbose Print the equivalent curl command for the visit operation -w, --wait int Number of seconds to wait for service(s) to become ready. 0 to disable (default 0) ```