-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
22 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,75 +1,57 @@ | ||
# daggerverse Vault Module | ||
# Daggerverse Vault Module | ||
|
||
[Dagger](https://dagger.io/) module for [daggerverse](https://daggerverse.dev/) providing Vault functionality. | ||
|
||
The Dagger module is located in the [vault-kv](./vault-kv/) directory. | ||
|
||
## usage | ||
## Usage | ||
|
||
Basic usage guide. | ||
|
||
The [vault-kv](./vault-kv/) directory contains a [daggerverse](https://daggerverse.dev/) [Dagger](https://dagger.io/) module. | ||
|
||
Check the official Dagger Module documentation: https://docs.dagger.io/zenith/ | ||
Check the official Dagger Module documentation: https://docs.dagger.io/ | ||
|
||
The [Dagger CLI](https://docs.dagger.io/cli) is needed. | ||
|
||
### functions | ||
### Functions | ||
|
||
List all functions of the module. This command is provided by the [Dagger CLI](https://docs.dagger.io/cli). | ||
List all functions of the module. This command is provided by the [Dagger CLI](https://docs.dagger.io/reference/cli/). | ||
|
||
```bash | ||
dagger functions -m ./vault-kv/ | ||
``` | ||
|
||
The vault-kv module is referenced locally. | ||
|
||
## development | ||
## Development | ||
|
||
Basic development guide. | ||
|
||
### setup Dagger module | ||
|
||
Setup the Dagger module. | ||
|
||
Create the directory for the module and initialize it. | ||
### Set up Dagger module | ||
|
||
```bash | ||
mkdir vault-kv/ | ||
# enter into the module's directory | ||
cd vault-kv/ | ||
|
||
# initialize Dagger module | ||
dagger mod init --sdk go --name vault-kv | ||
# initialize the module | ||
dagger develop --sdk go | ||
``` | ||
|
||
### setup development module | ||
|
||
Setup the outer module to be able to develop the Dagger vault-kv module. | ||
|
||
```bash | ||
dagger mod init --sdk go --name modest | ||
dagger mod use ./vault-kv | ||
``` | ||
|
||
Generate or re-generate the Go definitions file (dagger.gen.go) for use in code completion. | ||
|
||
```bash | ||
dagger mod install | ||
``` | ||
|
||
The functions of the module are available by the `dag` variable. Type `dag.` in your Go file for code completion. | ||
|
||
### Testing | ||
|
||
Update the module: | ||
This module contains a testing module that aims to test Dagger vault-kv module. | ||
|
||
```bash | ||
dagger mod update | ||
# enter into the test module's directory | ||
cd vault-kv/tests | ||
# initialize the module | ||
dagger develop --sdk go | ||
# execute the tests | ||
dagger call test | ||
``` | ||
|
||
## To Do | ||
|
||
- [ ] document functions | ||
- [ ] Add cache mounts | ||
- [ ] Add environment variables | ||
- [ ] Add more examples | ||
- [ ] Add tests |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
/dagger.gen.go linguist-generated | ||
/internal/dagger/** linguist-generated | ||
/internal/querybuilder/** linguist-generated | ||
/internal/telemetry/** linguist-generated |