Skip to content
This repository has been archived by the owner on Jan 8, 2024. It is now read-only.

Backport docs updates #4910

Merged
merged 8 commits into from
Oct 11, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 6 additions & 0 deletions website/content/commands/artifact-build.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'artifact build'
description: 'Build a new versioned artifact from source'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Artifact build

Command: `waypoint artifact build`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/artifact-list-builds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'artifact list-builds'
description: 'List builds.'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Artifact list-builds

Command: `waypoint artifact list-builds`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/artifact-list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'artifact list'
description: 'List pushed artifacts.'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Artifact list

Command: `waypoint artifact list`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/artifact-push.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'artifact push'
description: "Push a build's artifact to a registry"
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Artifact push

Command: `waypoint artifact push`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/auth-method-delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'auth-method delete'
description: 'Delete a previously configured auth method.'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Auth-method delete

Command: `waypoint auth-method delete`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/auth-method-inspect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'auth-method inspect'
description: 'Show detailed information about a configured auth method'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Auth-method inspect

Command: `waypoint auth-method inspect`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/auth-method-list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'auth-method list'
description: 'List all configured auth methods'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Auth-method list

Command: `waypoint auth-method list`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/auth-method-set-oidc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'auth-method set oidc'
description: 'Configure an OIDC auth method'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Auth-method set oidc

Command: `waypoint auth-method set oidc`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/build.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'build'
description: 'Build a new versioned artifact from source'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Build

Command: `waypoint build`
Expand Down
40 changes: 40 additions & 0 deletions website/content/commands/config-delete.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
layout: commands
page_title: 'Commands: Config delete'
sidebar_title: 'config delete'
description: 'Delete a config variable.'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Config delete

Command: `waypoint config delete`

Delete a config variable.

@include "commands/config-delete_desc.mdx"

## Usage

Usage: `waypoint config delete <name> <name2> ...`

Delete a config variable from the system. This cannot be undone.

#### Global Options

- `-plain` - Plain output: no colors, no animation. The default is false.
- `-app=<string>` (`-a`) - App to target. Certain commands require a single app target for Waypoint configurations with multiple apps. If you have a single app, then this can be ignored.
- `-project=<string>` (`-p`) - Project to target.
- `-workspace=<string>` (`-w`) - Workspace to operate in.

#### Command Options

- `-scope=<string>` - The scope for this configuration to delete. The configuration will only delete within this scope. This can be one of 'global', 'project', or 'app'. The default is project.
- `-label-scope=<string>` - If set, configuration will only be deleted if the deployment or operation has a matching label set.

@include "commands/config-delete_more.mdx"
6 changes: 6 additions & 0 deletions website/content/commands/config-get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'config get'
description: 'Get config variables.'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Config get

Command: `waypoint config get`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/config-set.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'config set'
description: 'Set a config variable.'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Config set

Command: `waypoint config set`
Expand Down
47 changes: 47 additions & 0 deletions website/content/commands/config-source-delete.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
layout: commands
page_title: 'Commands: Config source-delete'
sidebar_title: 'config source-delete'
description: 'Delete the configuration for a dynamic source plugin'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Config source-delete

Command: `waypoint config source-delete`

Delete the configuration for a dynamic source plugin

@include "commands/config-source-delete_desc.mdx"

## Usage

Usage: `waypoint config source-delete [options]`

Delete the configuration for a dynamic configuration source plugin.

To use this command, you should specify a "-type" flag. Please see the
documentation for the config source type you're configuring for details on
what configuration fields are available.

Configuration for this command is global. The "-app", "-project", and
"-workspace" flags are ignored on this command.

#### Global Options

- `-plain` - Plain output: no colors, no animation. The default is false.
- `-app=<string>` (`-a`) - App to target. Certain commands require a single app target for Waypoint configurations with multiple apps. If you have a single app, then this can be ignored.
- `-project=<string>` (`-p`) - Project to target.
- `-workspace=<string>` (`-w`) - Workspace to operate in.

#### Command Options

- `-type=<string>` - Dynamic source type to delete, such as 'vault'.
- `-scope=<string>` - The scope for this configuration source. The configuration source will only delete within this scope. This can be one of 'global', 'project', or 'app'. The default is global.

@include "commands/config-source-delete_more.mdx"
6 changes: 6 additions & 0 deletions website/content/commands/config-source-get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'config source-get'
description: 'Get the configuration for a dynamic source plugin'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Config source-get

Command: `waypoint config source-get`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/config-source-set.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'config source-set'
description: 'Set the configuration for a dynamic source plugin'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Config source-set

Command: `waypoint config source-set`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/config-sync.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'config sync'
description: 'Synchronize declared variables and pipeline configs in a waypoint.hcl'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Config sync

Command: `waypoint config sync`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/context-clear.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'context clear'
description: 'Unset the default context.'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Context clear

Command: `waypoint context clear`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/context-create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'context create'
description: 'Create a context.'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Context create

Command: `waypoint context create`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/context-delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'context delete'
description: 'Delete a context.'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Context delete

Command: `waypoint context delete`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/context-inspect.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'context inspect'
description: 'Output context info.'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Context inspect

Command: `waypoint context inspect`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/context-list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'context list'
description: 'List contexts.'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Context list

Command: `waypoint context list`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/context-rename.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'context rename'
description: 'Rename a context.'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Context rename

Command: `waypoint context rename`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/context-set.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'context set'
description: 'Set a property of the current context.'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Context set

Command: `waypoint context set`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/context-use.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'context use'
description: 'Set the default context.'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Context use

Command: `waypoint context use`
Expand Down
6 changes: 6 additions & 0 deletions website/content/commands/context-verify.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ sidebar_title: 'context verify'
description: 'Verify server access with a context'
---

<Warning>

This content is part of the legacy version of Waypoint that is no longer actively maintained. For additional information on the new vision of Waypoint, check out [this blog post](https://www.hashicorp.com/blog/a-new-vision-for-hcp-waypoint) and the [HCP Waypoint documentation](/hcp/docs/waypoint).

</Warning>

# Waypoint Context verify

Command: `waypoint context verify`
Expand Down
Loading