exivity / pulumiconfig

Manage your pulumi config with ease

PulumiConfig

Experimental Project: This project is in an experimental phase and may undergo significant changes. Use at your own risk.

PulumiConfig is a Golang library designed to improve the way developers manage configuration in Pulumi. By leveraging Golang structs, it simplifies the process of tracking and validating configuration keys, ensuring a more efficient and error-free deployment process in cloud infrastructure projects.

Features

• Seamless Integration: Effortlessly integrates with Pulumi and Golang projects.
• Automated Key Tracking: Automatically tracks configuration keys using Golang structs.
• JSON Tagging: Supports JSON tagging for Pulumi configuration keys, including nested structs.
• Validation: Integrates with the Go Playground Validator for custom validation logic, allowing required values and complex validations.

Installation

To integrate PulumiConfig into your Golang project, follow these steps:

go get -u github.com/exivity/pulumiconfig

Usage

Basic Usage

import (
    "github.com/exivity/EaaS-Pulumi-Deployment/pkg/providers/config"
)

// Example of defining a PulumiConfig struct
type PulumiConfig struct {
    Name string `pulumi:"name" validate:"default=john-doe"`
}

// Example deployment function using PulumiConfig
func main() error {
    ...
    cfg := &PulumiConfig{}
    err = pulumiconfig.GetConfig(ctx, cfg, config.GetCustomValidations(ctx)...)
    ...
}

Advanced Features

• Custom Validation Logic: Implement the Validator interface to create custom validation types. This is useful for scenarios that require specific validation rules beyond standard checks.

Example Snippets

func GetCustomValidations(ctx *pulumi.Context) []pulumiconfig.Validator {
    return []pulumiconfig.Validator{
        &MyValidator{
            pulumiconfig.FieldValidation{
                Tag:      "Register",
                Validate: Register,
            },
        },
    }
}

func Register(validate *validator.Validate) error {
    // Register custom validation logic
}

// Using type conversions in PulumiConfig
type MyConfig struct {
    MyNumber string `pulumi:"myNumber" validate:"required"`
}

Contributing

We welcome contributions! Please refer to the CODEOWNERS file for guidelines on contributing to PulumiConfig.

License

PulumiConfig is released under MIT. See the LICENSE file for more details.

pulumiconfig's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• fix(deps): update module github.com/go-playground/validator/v10 to v10.22.0
• fix(deps): update module github.com/pulumi/pulumi/sdk/v3 to v3.121.0

Detected dependencies

github-actions

.github/workflows/main.yml

• actions/checkout v4
• actions/setup-go v5

gomod

go.mod

• go 1.22.3
• github.com/go-playground/validator/v10 v10.21.0
• github.com/pulumi/pulumi/sdk/v3 v3.118.0
• github.com/stretchr/testify v1.9.0

---

• Check this box to trigger a request for Renovate to run again on this repository