package
0.11.4
Repository: https://github.com/hashicorp/waypoint.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# Functions

Asset loads and returns the asset for the given name.
AssetDigest returns the digest of the file with the given name.
AssetDir returns the file names below a certain directory embedded in the file by go-bindata.
AssetInfo loads and returns the asset info for the given name.
AssetNames returns the names of the assets.
AssetString returns the asset contents as a string (instead of a []byte).
Digests returns a map of all known files and their checksums.
MustAsset is like Asset but panics when Asset would return an error.
MustAssetString is like AssetString but panics when Asset would return an error.
No description provided by the author
RegisterWaypointHandler registers the http handlers for service Waypoint to "mux".
RegisterWaypointHandlerClient registers the http handlers for service Waypoint to "mux".
RegisterWaypointHandlerFromEndpoint is same as RegisterWaypointHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
RegisterWaypointHandlerServer registers the http handlers for service Waypoint to "mux".
No description provided by the author
RestoreAsset restores an asset under the given directory.
RestoreAssets restores an asset under the given directory recursively.

# Constants

AssetDebug is true if the assets were built with the debug flag enabled.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
https://mermaid-js.github.io/mermaid/.
We assume HCL by default.
No description provided by the author
The "traditional" instance type, a process that is running constantly for a long period of time.
An instance that was launched in response to a request and will disappear quickly.
An instance that is not actually running any code, but registers itself as an instance for the purposes of interacting with the exec and logs functionality.
File is when the waypoint.hcl was loaded from a file either on disk (local actions) or the attached repository (GitOps).
Job is when the waypoint.hcl was loaded directly from the job by being embedded in the "waypoint_hcl" field (tag 12).
Server is when the waypoint.hcl was loaded from the server from being written directly in the project settings.
Unknown should never be set, but represents a zero value.
job failed.
queued and waiting for assignment.
runner acked and is executing.
job succeeded.
No description provided by the author
assigned to a runner, waiting for runner to ack.
LogBatch_Entry_APP
App is zero for backwards compatibility since Source was added later this allows the default to just work.
LogBatch_Entry_ENTRYPOINT
Entrypoint logs.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
when any job gets manually cancelled, the entire pipeline aborts.
when any job errors, the pipeline aborts.
pipeline run created.
jobs are working.
root_job queued.
last_job completed.
no state defined, the default.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
i.e.
i.e.
i.e.
i.e.
catch-all for types that do not fit well into other predefined roles.
i.e.
i.e.
i.e.
No description provided by the author
Explicitly adopted.
New runner we've never seen before or has been forgotten.
Runner provided a valid runner token despite not being explicitly adopted.
Explicitly rejected.
Advertises that this server is capable of receiving inline keepalive messages.
No description provided by the author
Expect a series of BoltChunk messages.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
We're expecting it to exist, but it does not.
Some resources in deployment are OK, others are not OK.
No description provided by the author
No description provided by the author
task is done.
jobs are in an undefined state that don't match our expectation.
no jobs have been ran yet.
task is running.
start_job complete, task is not running yet.
start_job is running.
every job in Task triple is stopped.
stop_job is running.
no state defined, the default.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
This is the final used value's source that is supplied to the user in outputs.
No description provided by the author

# Variables

Enum value maps for Component_Type.
Enum value maps for Component_Type.
Enum value maps for Deployment_LoadDetails.
Enum value maps for Deployment_LoadDetails.
Enum value maps for EntrypointExecRequest_Output_Channel.
Enum value maps for EntrypointExecRequest_Output_Channel.
Enum value maps for ExecStreamResponse_Output_Channel.
Enum value maps for ExecStreamResponse_Output_Channel.
No description provided by the author
Enum value maps for GetPipelineResponse_Graph_Format.
Enum value maps for GetPipelineResponse_Graph_Format.
Enum value maps for Hcl_Format.
Enum value maps for Hcl_Format.
Enum value maps for Instance_Type.
Enum value maps for Instance_Type.
Enum value maps for Job_Config_Source.
Enum value maps for Job_Config_Source.
Enum value maps for Job_State.
Enum value maps for Job_State.
LogBatch_Entry_Source_name
Enum value maps for LogBatch_Entry_Source.
LogBatch_Entry_Source_value
Enum value maps for LogBatch_Entry_Source.
Enum value maps for OIDCAuthMethod_Kind.
Enum value maps for OIDCAuthMethod_Kind.
Enum value maps for Operation_PhysicalState.
Enum value maps for Operation_PhysicalState.
Enum value maps for OperationOrder_Order.
Enum value maps for OperationOrder_Order.
Enum value maps for PipelineRun_State.
Enum value maps for PipelineRun_State.
Enum value maps for Project_ProjectState.
Enum value maps for Project_ProjectState.
Enum value maps for Release_LoadDetails.
Enum value maps for Release_LoadDetails.
Enum value maps for ResourceCategoryDisplayHint.
Enum value maps for ResourceCategoryDisplayHint.
Enum value maps for Runner_AdoptionState.
Enum value maps for Runner_AdoptionState.
Enum value maps for ServerFeaturesFeature.
Enum value maps for ServerFeaturesFeature.
Enum value maps for Snapshot_Header_Format.
Enum value maps for Snapshot_Header_Format.
Enum value maps for Status_State.
Enum value maps for Status_State.
Enum value maps for StatusReport_Resource_Health.
Enum value maps for StatusReport_Resource_Health.
Enum value maps for Task_State.
Enum value maps for Task_State.
Enum value maps for UpsertDeploymentRequest_Tristate.
Enum value maps for UpsertDeploymentRequest_Tristate.
Enum value maps for Variable_FinalValue_Source.
Enum value maps for Variable_FinalValue_Source.
Waypoint_ServiceDesc is the grpc.ServiceDesc for Waypoint service.

# Structs

No description provided by the author
No description provided by the author
Artifact is the result of a build or registry.
AuthMethod is a mechanism for authenticating to the Waypoint server.
No description provided by the author
No description provided by the author
Build represents a process of creating an artifact that can be in any state, such as complete.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Component represents metadata about a component.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ConfigVars represent configuration variables for applications and runners.
No description provided by the author
No description provided by the author
DynamicVal is the configuration for dynamic values for configuration.
No description provided by the author
No description provided by the author
No description provided by the author
Target sets the target where this configuration variable will be set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Passed to ConvertInviteToken to create a new token that can be used to authenticate RPCs.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
One day we may add information here.
No description provided by the author
A platform resource that an operation (release/deployment) has created, depends on, or manages.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A deployment with additional related messages pre-fetched.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A batch of data for log streaming from the entrypoint.
ErrorDetail is intended for use in `status`.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
id of job expedited by the request.
No description provided by the author
No description provided by the author
Generation is a shared message type used by operations to denote the "generation" they're a part of.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Graph represents the execution graph for the pipeline steps.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Hcl is a message used to encapsulate the contents of an HCL file.
Represents a key used to sign tokens using HMAC.
No description provided by the author
No description provided by the author
No description provided by the author
TargetApp targets an application in a specific workspace.
InlineKeepalive is a message intended to be sent down existing grpc streams to induce traffic and prevent them from being idle terminated by load balancers that do not respect http2 pings.
An instance is a single running process for a deployment.
Passed with GenerateInviteToken with the params on how the invite token should be generate.
A Job is a job that executes on a runner and is queued by QueueOperation.
No description provided by the author
AuthOp is the configuration to authenticate any plugins.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Ref is a reference to the exact set of data used by a data source.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DestroyProjectOp triggers the deletion of a project from the database as well as (optionally) the destruction of all resources created within a project.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Used to start a platform's exec function within a runner.
No description provided by the author
No description provided by the author
Basic auth.
No description provided by the author
Ref is used to populate DataSource.Ref.
No description provided by the author
SSH private key auth.
No description provided by the author
InitOp triggers an init action for a project (the equivalent of `waypoint init`).
No description provided by the author
No description provided by the author
No description provided by the author
Used to start a platform's log function within a runner.
Noop operations do nothing.
No description provided by the author
No description provided by the author
No description provided by the author
PipelineStepOp triggers the execution of a pipeline step.
Note that since we run pipeline steps as jobs, the output of the pipeline execution is in the job log.
No description provided by the author
PollOp triggers a poll action for a project.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
QueueProjectOp queues a job for all applications in a project.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
TaskPluginParams contains the information about a specific task plugin that is used by both StartTask and StopTask.
No description provided by the author
UpOp runs the "waypoint up" logic: it does a build (with push), deploy, and release all in one.
UpResult is the result of an UpOp.
No description provided by the author
ValidateOp validates various aspects of a configuration.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NOTE(xx): these requests will be refactored in a future PR to optimize for UI Will also add PipelineBundle and PipelineRunBundle objects.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ListTriggerRequest can take a handful of optional filter arguments.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
LogBatch_Entry
No description provided by the author
No description provided by the author
Returned by any action that creates a token.
This is used by ListOIDCAuthMethods to return the minimal information for an OIDC auth method in an unauthenticated setting.
******************************************************************* OnDemand Runners ******************************************************************.
Operation is a shared message type used to describe "operations" which are executions of a build, deploy, etc.
OperationOrder is a shared message type used for controlling the order of results in queries for app operations such as build, deploys, etc.
https://github.com/hashicorp/cloud-api/blob/master/hashicorp/cloud/common/pagination.proto PaginationRequest are the parameters for a paginated list request.
PaginationResponse is the response holding the page tokens for a paginated list response.
No description provided by the author
No description provided by the author
A single step within the pipeline.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Ref contains shared messages used for references to other resources.
Application references an application.
No description provided by the author
No description provided by the author
No description provided by the author
AuthMethod references an auth method.
Component references a component.
DeclaredResource references a declared resource.
No description provided by the author
No description provided by the author
No description provided by the author
Global references the entire server.
Job references a Job message value by job id.
OnDemandRunnerConfig references an OnDemandRunnerConfig value to be used for contextual operation.
Operation references an operation (build, deploy, etc.).
No description provided by the author
No description provided by the author
OperationSeq references an operation by sequence number.
Pipeline references a pipeline using one or more lookup types.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Project references a project.
Runner references a runner process which executes operations.
No description provided by the author
No description provided by the author
No description provided by the author
RunnerAny will reference any runner.
RunnerId references a runner by ID.
RunnerLabels references a runner by labels.
Task references a Task message by its id or the main run job id it queued.
No description provided by the author
No description provided by the author
Trigger references a Trigger message value to be used for a given operation.
User references a user by either ID or username, it is up to the caller.
No description provided by the author
No description provided by the author
UserId references a user by their ID (ULID-formatted).
UserUsername references a user by their username.
Workspace references a workspace.
No description provided by the author
No description provided by the author
A release with additional related messages pre-fetched.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ServerConfig is the configuration for the server that can be read and set online.
No description provided by the author
Represents features that the server supports.
No description provided by the author
No description provided by the author
Snapshot is the encoding of the snapshot for all snapshot APIs.
BoltChunk is a single chunk of data for BoltDB if the snapshot format is BOLT.
Header is _always_ the first message encoded into a snapshot.
Trailer is sent as the final message encoded into a snapshot.
No description provided by the author
Status represents the status of an async operation.
No description provided by the author
No description provided by the author
No description provided by the author
StatusReport is the report genrated when querying the overall health of a deployed or released application.
No description provided by the author
No description provided by the author
No description provided by the author
A resource as observed in a platform.
Task tracks the life of an on-demand runner task that spawns Start and Stop tasks for any kind of job/operation in Waypoint.
TaskLaunchInfo gets stored on the job/operation when queued for execution.
The authenticated Token information.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The Trigger message is a kind of token type that is only used for authenticated trigger URL requests.
No description provided by the author
The outer structure of the token that is directly Marshaled and ASCII armored.
The OAuth message contains information that the client should use to generate on OAuth token for authenticating with the server rather than just submitting the waypoint token directly.
No description provided by the author
The Trigger message is a representation of a URL that can be requested for invoking specific lifecycle operations on a projects applications.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
******************************************************************* UI ******************************************************************.
A deployment packaged alongside prefetched related messages.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
A release packaged alongside prefetched related messages.
UnimplementedWaypointServer must be embedded to have forward compatible implementations.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
User represents a single user identity within the Waypoint server.
Link is a connection between an authentication provider and the user identity.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Variable stores a variable's value, and metadata to allow for precedence sorting and source-specific error messaging.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Types mapped from https://pkg.go.dev/github.com/hashicorp/hcl/v2#Pos.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Interfaces

UnsafeWaypointServer may be embedded to opt out of forward compatibility for this service.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WaypointClient is the client API for Waypoint service.
WaypointServer is the server API for Waypoint service.

# Type aliases

Supported component types, the values here MUST match the enum values in the Go sdk/component package exactly.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
HCL files can be in either HCL or JSON syntax.
Instances are one of a these types.
Source is the location where the configuration was loaded from.
No description provided by the author
LogBatch_Entry_Source
No description provided by the author
No description provided by the author
PhysicalState is the state of any physical resources associated with an operation.
No description provided by the author
No description provided by the author
ProjectState is set to active when the project is created and throughout its lifetime.
No description provided by the author
No description provided by the author
Valid adoption states.
No description provided by the author
No description provided by the author
No description provided by the author
the state of overall health of a deployed application.
No description provided by the author
No description provided by the author
No description provided by the author