vault
Installation
Entrypoint
Types
Vault
UserpassAuth

vault

No long description provided.

Installation

dagger install github.com/nicholasjackson/demo-dagger-vault/dagger/modules/vault@36cd683c86b8ddd9a4072143d048ec400064da14

Entrypoint

Return Type

Vault

Example

func (m *myModule) example() *Vault  {
	return dag.
			Vault()
}

@function
def example() -> dag.Vault:
	return (
		dag.vault()
	)

@func()
example(): Vault {
	return dag
		.vault()
}

Types

Vault 🔗

namespace() 🔗

Return Type

String !

Example

dagger -m github.com/nicholasjackson/demo-dagger-vault/dagger/modules/vault@36cd683c86b8ddd9a4072143d048ec400064da14 call \
 namespace

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Vault().
			Namespace(ctx)
}

@function
async def example() -> str:
	return await (
		dag.vault()
		.namespace()
	)

@func()
async example(): Promise<string> {
	return dag
		.vault()
		.namespace()
}

host() 🔗

Return Type

String !

Example

dagger -m github.com/nicholasjackson/demo-dagger-vault/dagger/modules/vault@36cd683c86b8ddd9a4072143d048ec400064da14 call \
 host

func (m *myModule) example(ctx context.Context) string  {
	return dag.
			Vault().
			Host(ctx)
}

@function
async def example() -> str:
	return await (
		dag.vault()
		.host()
	)

@func()
async example(): Promise<string> {
	return dag
		.vault()
		.host()
}

userpass() 🔗

Return Type

UserpassAuth !

Example

Function Vault.userpass is not accessible from the vault module

func (m *myModule) example() *VaultUserpassAuth  {
	return dag.
			Vault().
			Userpass()
}

@function
def example() -> dag.VaultUserpassAuth:
	return (
		dag.vault()
		.userpass()
	)

@func()
example(): VaultUserpassAuth {
	return dag
		.vault()
		.userpass()
}

withNamespace() 🔗

WithNamespace sets the namespace for the Vault client

Return Type

Vault !

Arguments

Name	Type	Default Value	Description
namespace	String !	-	No description provided

Example

dagger -m github.com/nicholasjackson/demo-dagger-vault/dagger/modules/vault@36cd683c86b8ddd9a4072143d048ec400064da14 call \
 with-namespace --namespace string \
 get-secret-json --secret string

func (m *myModule) example(namespace string) *Vault  {
	return dag.
			Vault().
			WithNamespace(namespace)
}

@function
def example(namespace: str) -> dag.Vault:
	return (
		dag.vault()
		.with_namespace(namespace)
	)

@func()
example(namespace: string): Vault {
	return dag
		.vault()
		.withNamespace(namespace)
}

withHost() 🔗

WithHost sets the host for the Vault client

Return Type

Vault !

Arguments

Name	Type	Default Value	Description
host	String !	-	No description provided

Example

dagger -m github.com/nicholasjackson/demo-dagger-vault/dagger/modules/vault@36cd683c86b8ddd9a4072143d048ec400064da14 call \
 with-host --host string \
 get-secret-json --secret string

func (m *myModule) example(host string) *Vault  {
	return dag.
			Vault().
			WithHost(host)
}

@function
def example(host: str) -> dag.Vault:
	return (
		dag.vault()
		.with_host(host)
	)

@func()
example(host: string): Vault {
	return dag
		.vault()
		.withHost(host)
}

withUserpassAuth() 🔗

WithUserpassAuth sets the userpass autrhentication for the Vault client

Return Type

Vault !

Arguments

Name	Type	Default Value	Description
username	String !	-	No description provided
password	String !	-	No description provided
path	String	"userpass"	No description provided

Example

dagger -m github.com/nicholasjackson/demo-dagger-vault/dagger/modules/vault@36cd683c86b8ddd9a4072143d048ec400064da14 call \
 with-userpass-auth --username string --password string \
 get-secret-json --secret string

func (m *myModule) example(username string, password string) *Vault  {
	return dag.
			Vault().
			WithUserpassAuth(username, password)
}

@function
def example(username: str, password: str) -> dag.Vault:
	return (
		dag.vault()
		.with_userpass_auth(username, password)
	)

@func()
example(username: string, password: string): Vault {
	return dag
		.vault()
		.withUserpassAuth(username, password)
}

getSecretJson() 🔗

GetSecretJSON returns a vault secret as a JSON string

Return Type

String !

Arguments

Name	Type	Default Value	Description
secret	String !	-	No description provided
params	String	-	No description provided
operationType	String	"read"	No description provided

Example

dagger -m github.com/nicholasjackson/demo-dagger-vault/dagger/modules/vault@36cd683c86b8ddd9a4072143d048ec400064da14 call \
 get-secret-json --secret string

func (m *myModule) example(ctx context.Context, secret string) string  {
	return dag.
			Vault().
			GetSecretJson(ctx, secret)
}

@function
async def example(secret: str) -> str:
	return await (
		dag.vault()
		.get_secret_json(secret)
	)

@func()
async example(secret: string): Promise<string> {
	return dag
		.vault()
		.getSecretJson(secret)
}

testGetSecret() 🔗

TestGetSecret is a test function for the GetSecretJSON function example usage: dagger call test-get-secret –host \({VAULT_ADDR} --namespace=\){VAULT_NAMESPACE} –username=VAULT_USER –password=VAULT_PASSWORD –secret=kubernetes/hashitalks/creds/deployer-default –params=“kubernetes_namespace=default” –op-type=write

Return Type

String !

Arguments

Name	Type	Default Value	Description
host	String !	-	No description provided
namespace	String !	-	No description provided
username	Secret !	-	No description provided
password	Secret !	-	No description provided
secret	String !	-	No description provided
opType	String	"read"	No description provided
params	String	-	No description provided

Example

dagger -m github.com/nicholasjackson/demo-dagger-vault/dagger/modules/vault@36cd683c86b8ddd9a4072143d048ec400064da14 call \
 test-get-secret --host string --namespace string --username env:MYSECRET --password env:MYSECRET --secret string

func (m *myModule) example(ctx context.Context, host string, namespace string, username *Secret, password *Secret, secret string) string  {
	return dag.
			Vault().
			TestGetSecret(ctx, host, namespace, username, password, secret)
}

@function
async def example(host: str, namespace: str, username: dagger.Secret, password: dagger.Secret, secret: str) -> str:
	return await (
		dag.vault()
		.test_get_secret(host, namespace, username, password, secret)
	)

@func()
async example(host: string, namespace: string, username: Secret, password: Secret, secret: string): Promise<string> {
	return dag
		.vault()
		.testGetSecret(host, namespace, username, password, secret)
}

UserpassAuth 🔗

username() 🔗

Return Type

String !

Example

Function VaultUserpassAuth.username is not accessible from the vault module

Function VaultUserpassAuth.username is not accessible from the vault module

Function VaultUserpassAuth.username is not accessible from the vault module

Function VaultUserpassAuth.username is not accessible from the vault module

password() 🔗

Return Type

String !

Example

Function VaultUserpassAuth.password is not accessible from the vault module

Function VaultUserpassAuth.password is not accessible from the vault module

Function VaultUserpassAuth.password is not accessible from the vault module

Function VaultUserpassAuth.password is not accessible from the vault module

path() 🔗

Return Type

String !

Example

Function VaultUserpassAuth.path is not accessible from the vault module

Function VaultUserpassAuth.path is not accessible from the vault module

Function VaultUserpassAuth.path is not accessible from the vault module

Function VaultUserpassAuth.path is not accessible from the vault module