WIP - Waypoint Client

DISCLAIMER - THIS PACKAGE IS NOT READY FOR PRODUCTION USUAGE. BREAKING CHANGES SHOULD BE EXPECTED

Hashicorp Waypoint has a builtin gRPC API that can be used to interact with the Waypoint Server; however, the SDK does not ship with a client to interact with this API. This is Go client library for Waypoint that exposes some of the gRPC methods in order to interact with the server.

Supported methods

Currently, the library supports the following methods:

1. GetVersion - This gets the Waypoint version information from the server.
2. GetProject - This method gets information about a named Waypoint project.
3. GetUser - This retrieves information about a Waypoint user.
4. CreateToken - This will create an authentication token for a names user.
5. InviteUser - This will create an invitation token for a new user to be onboarded to the Waypoint server.
6. AcceptInvitation - This method creates the user and exchanges an invitation token for an authentication token.
7. DeleteUser - This will delete a named user from the Waypoint server.
8. ListProject - This will list all Waypoint projects on the server.
9. UpsertProject - This will create or update a Waypoint project.
10. CreateRunnerProfile - This will create a new runner profile.
11. GetRunnerProfile - This gets a list of existing runner profiles.
12. UpsertOidc - This will create or update an OIDC auth method.
13. DeleteOidc - This will delete an OIDC auth method.
14. GetApp - This method gets the Waypoint application.
15. UpsertApp - This will create or update a Waypoint application.

More methods are constantly being added to this library. If a method you require isn't currently supported, please do open an issue on this repo or submit a Pull Request.

Usage

To use this client library, import the github.com/hashicorp-dev-advocates/waypoint-client/pkg/client package to your project. Configuring the client can be done with the following information as a minimum requirement:

1. Waypoint token
2. Waypoint server address

In the below example, the Waypoint token is fetched from an environment variable and the address is hard coded:

package main

import (
	"log"
	"os"

	"github.com/hashicorp-dev-advocates/waypoint-client/pkg/client"
)

var token string

func main() {

	token = os.Getenv("WAYPOINT_TOKEN")
	if token == "" {
		log.Fatal("WAYPOINT_TOKEN environment variable not set")
	}

	// create a client
	conf := client.DefaultConfig()
	conf.Token = token
	conf.Address = "localhost:9701"

	wp, err := client.New(conf)
	if err != nil {
		log.Fatal(err)
	}
	
}

GetVersion Example

info, err := wp.GetVersionInfo(context.TODO())
if err != nil {
    panic(err)
}

fmt.Println(info.Version)
fmt.Println(info.Entrypoint)
fmt.Println(info.Api)

GetProject Example

gpr,err := wp.GetProject(context.TODO(), "Test")
if err != nil {
    panic(err)
}

fmt.Println(gpr.Name)
fmt.Println(gpr.Variables)
fmt.Println(gpr.Applications)

CreateToken Example

username := client.UserId("00000000000000000000000001")
tk, err := wp.CreateToken(context.TODO(), &username)
if err != nil {
    panic(err)
}

fmt.Println(tk)

GetUser Example

gu, err := wp.GetUser(context.TODO(), "DevOpsRob")
if err != nil {
panic(err)
}

fmt.Printf("Username: %s \n", gu.Username)
fmt.Printf("User ID: %s \n", gu.Id)

InviteUser & AcceptInvitation Example

inviteUsername := "DevOpsRob"
inv, err := wp.InviteUser(context.TODO(), inviteUsername, "30s")
if err != nil {
    panic(err)
}

tok, err := wp.AcceptInvitation(context.TODO(), inv)
if err != nil {
    panic(err)
}

fmt.Printf("Token: %s \n", tok)

DeleteUser Example

_, err = wp.DeleteUser(context.TODO(), client.UserId("01G13MNGG5YZ6GNDF3FSXNA18X"))
if err != nil {
    log.Fatal(err)
}

UpsertOidc Example

	amc := client.DefaultAuthMethodConfig()
	amc.Name = "test_oidc"
	amc.DisplayName = "Test OIDC"
	
	oidcConfig := client.DefaultOidcConfig()
	oidcConfig.ClientId = "060d0801-6fv7-4b03-ad59-b6397e2hc4ad"
	oidcConfig.ClientSecret = "lFBsQ~Gb2E7p3Q3jr9jrWWw6aIQ5L3tYJ3wzLc1q"
	oidcConfig.DiscoveryUrl = "https://login.microsoftonline.com/<insert-tenant-ID-here>/v2.0"
	oidcConfig.AllowedRedirectUris = []string{"https://localhost:9702/auth/oidc-callback", "http://localhost:9701/oidc/callback"}

	uam, err := wp.UpsertOidc(context.TODO(), oidcConfig, amc)

DeleteOidc Example

	err = wp.DeleteOidc(context.TODO(), "test_oidc")
	if err != nil {
		println(err)
	}

GetOidcAuthMethod Example

	gam, err := wp.GetOidcAuthMethod(context.TODO(), "test_oidc")
	fmt.Println(gam.AuthMethod)

CreateRunnerProfile Example

	var envVarsMap = map[string]string{
		"VAULT_ADDR":  "http://localhost:8200",
		"VAULT_TOKEN": "This is not a token",
	}
	
	dCon := client.DefaultRunnerConfig()
	dCon.Name = "mclarennn"
	dCon.OciUrl = "hashicorp/waypoint-odr:latest"
	dCon.EnvironmentVariables = envVarsMap
	dCon.Default = true
	dCon.PluginType = "docker"
	dCon.TargetRunner = &gen.Ref_Runner{Target: &gen.Ref_Runner_Id{Id: &gen.Ref_RunnerId{Id: "01G5GNJEYC7RVJNXFGMHD0HCDT"}}}
	
	urp, err := wp.CreateRunnerProfile(context.TODO(), dCon)
    if err != nil {
    println(err)
    }
	
	fmt.Println(urp)

GetRunnerProfile Example

	grc, err := wp.GetRunnerProfile(context.TODO(), "01G5K41M48RY2DRZAMWJB4JYE4")
	fmt.Println(grc.Config)

ListProjects Example

	prl, err := wp.ListProject(context.TODO())
	pretty.Println(prl)

GetProject Example

	gpr, err := wp.GetProject(context.TODO(), "robbarnes")
	if err != nil {
		fmt.Println(err)
	}
	
	fmt.Println(gpr)

UpsertProject Example

	gc := client.Git{
		Url:  "https://github.com/hashicorp/waypoint-examples",
		Path: "docker/go",
	}
	
	projconf := client.DefaultProjectConfig()
	
	projconf.Name = "robbarnes"
	projconf.RemoteRunnersEnabled = false
	projconf.GitPollInterval = 30 * time.Second
	
	var1 := client.SetVariable()
	var1.Name = "name"
	var1.Value = &gen.Variable_Str{Str: "Devops Rob"}
	
	var2 := client.SetVariable()
	var2.Name = "role"
	var2.Value = &gen.Variable_Str{Str: "Developer Advocate"}
	
	var varList []*gen.Variable
	
	varList = append(varList, &var1, &var2)
	projconf.StatusReportPoll = 0 * time.Second
	
	npr, err := wp.UpsertProject(context.TODO(), projconf, &gc, varList)
	if err != nil {
		panic(err)
	}
	
	fmt.Println(npr)

GetApp Example

    gpr, err := wp.GetApp(context.TODO(), "example-nodejs", "example-nodejs")
    if err != nil {
        fmt.Println(err)
    }
    
    fmt.Println(gpr)
	

UpsertApp Example

    appConf := client.DefaultApplicationConfig()

    // App config for request
    appConf.Name = "appName"
    appConf.Project = &gen.Ref_Project{Project: "projName"}
    
    app, err := r.client.UpsertApp(ctx, appConf)