New Interested in participating in the HCP Waypoint Private Beta Program? Apply here
  • Infrastructure
    • terraform
    • packer
  • Networking
    • consul
  • Security
    • vault
    • boundary
  • Applications
    • nomad
    • waypoint
    • vagrant
  • HashiCorp Cloud Platform

    A fully managed platform to automate infrastructure on any cloud with HashiCorp products.

    • consul
    • terraform
    • vault
    • packerbeta
    Visit cloud.hashicorp.com
  • Overview
  • Tutorials
  • Docs
  • CLI
  • Plugins
  • Community
GitHub
Download
    • Overview
      • Overview
      • Helm
      • Heroku, Vercel, etc.
      • Kubernetes
  • Getting Started
    • Overview
    • Compatibility Promise
    • Protocol Version Table
    • Release Notifications
      • Overview
      • Upgrade to 0.2.0
      • Upgrade to 0.3.0
      • Upgrade to 0.4.0
      • Upgrade to 0.5.0
      • Upgrade to 0.6.0
      • Upgrade to 0.7.0
      • Upgrade to 0.8.0

    • Install
    • Externally Built Images
    • Building Container Images
    • Helm Deployment
    • YAML-Free Deployment
    • YAML Directory Deployment
    • Resource Status
    • ConfigMaps and Secrets

    • Overview
    • Git Integration
    • Remote Operations
    • Overview
    • Build
    • Deploy
    • Release
    • Hooks
    • Labels
    • Workspace and Label Scoping
    • Overview
      • Overview
      • Input Variables
      • External Data
      • artifact
      • deploy
      • entrypoint
      • labels
      • path
      • workspace
      • Overview
      • Full Reference
      • Templating
      • Overview
      • Expressions
      • JSON Syntax
    • app
    • build
    • config
    • deploy
    • hook
    • plugin
    • registry
    • release
    • runner
    • url
    • use
    • variable
  • URL Service
  • Logs
  • Exec
    • Overview
    • Dynamic Values
    • Files
    • Internal Values
    • Workspace and Label Scoping
    • Overview
      • Overview
      • OIDC
      • Tokens
      • Overview
      • Maintenance
      • Production
      • Security
    • Express Server Install
    • Overview
    • Configuration
    • Profiles
    • On-Demand Runner
    • Additional Runners
  • Workspaces
  • Plugins
  • Triggers

    • Overview
      • Overview
      • Registering Plugin Components
      • Handling Configuration
      • Implementing the Builder Interface
      • Compiling the Plugin
      • Creating an Example Application
      • Testing the Plugin
    • Initializing the SDK
    • Passing Values Between Components
      • Overview
      • Authenticator
      • ConfigSourcer
      • Configurable
      • ConfigurableNotify
      • Builder
      • Registry
      • Platform
      • ReleaseManager
      • Destroy
      • Status
      • Default Parameters
      • Overview
    • Overview
    • Disable
    • Overview
    • GitHub Actions
    • GitLab CI/CD
    • CircleCI
    • Jenkins
  • Troubleshooting
  • Glossary

    • Overview
    • Architecture
    • Operation Execution
  • Roadmap
Type '/' to Search

»Integrating Waypoint with Jenkins

Using Waypoint to deploy an application from within Jenkins is similar to how you might deploy an application from your own workspace.

Your Jenkins runner must have Waypoint installed to execute it in a step. This can be accomplished by installing Waypoint on the runner using the standard installation instructions such as from the Waypoint apt repository. In addition, any dependencies such as authentication details or anything else required by Waypoint plugins must be available in the execution environment.

Note that this example assumes use of a declarative pipeline.

Note: The Waypoint server authentication variables here are inlined but it is recommended to set the secret environment variables in a secure fashion such as credentials binding

»Workspaces

This example assumes the use of a single default workspace. If this was in a job triggered by a GitHub commit or pull request and may be an ephemeral development environment, you may want to interpolate the relevant Git ref for the workspace parameter using something like the git parameter plugin, as demonstrated below:

stage('waypoint build') {
    steps {
        sh 'waypoint build -workspace "${params.BRANCH}"'
    }
}
stage('waypoint build') {
    steps {
        sh 'waypoint build -workspace "${params.BRANCH}"'
    }
}

»Example

pipeline {
    agent any

    // Assumes you are deploying a Node.js application
    tools { nodejs "default" }

    environment {
        WAYPOINT_VERSION = '0.1.0'
        WAYPOINT_SERVER_ADDR = ''
        WAYPOINT_SERVER_TOKEN = ''
        WAYPOINT_SERVER_TLS = '1'
        WAYPOINT_SERVER_TLS_SKIP_VERIFY = '1'
    }

    stages {
        stage('waypoint init') {
            steps {
                sh 'waypoint init'
            }
        }

        stage('waypoint build') {
            steps {
                sh 'waypoint build'
            }
        }

        stage('waypoint deploy') {
            steps {
                sh 'waypoint deploy'
            }
        }

        stage('waypoint release') {
            steps {
                sh 'waypoint release'
            }
        }
    }
}
pipeline {
    agent any

    // Assumes you are deploying a Node.js application
    tools { nodejs "default" }

    environment {
        WAYPOINT_VERSION = '0.1.0'
        WAYPOINT_SERVER_ADDR = ''
        WAYPOINT_SERVER_TOKEN = ''
        WAYPOINT_SERVER_TLS = '1'
        WAYPOINT_SERVER_TLS_SKIP_VERIFY = '1'
    }

    stages {
        stage('waypoint init') {
            steps {
                sh 'waypoint init'
            }
        }

        stage('waypoint build') {
            steps {
                sh 'waypoint build'
            }
        }

        stage('waypoint deploy') {
            steps {
                sh 'waypoint deploy'
            }
        }

        stage('waypoint release') {
            steps {
                sh 'waypoint release'
            }
        }
    }
}
github logoEdit this page

Using Waypoint

The best way to understand what Waypoint can enable for your projects is to give it a try.

Waypoint tutorials
Waypoint documentation
Tutorial

Get Started - Kubernetes

Build, deploy, and release applications to a Kubernetes cluster.

View
Tutorial

Introduction to Waypoint

Waypoint enables you to publish any application to any platform with a single file and a single command.

View

Waypoint is maintained by HashiCorp, Inc.

View Code of Conduct
DocumentationCLI ReferenceTutorialsIntegrations
All systems normal