blueprint-resolvers

README

blueprint resolvers

A library that provides a collection of blueprint framework ChildResolver implementations for sourcing child blueprints referenced through the use of the include property in a parent blueprint.

Implementations

• File system - Resolves child blueprints from a provided file system.
• S3 - Resolves child blueprints from an S3 bucket.
• Google Cloud Storage - Resolves child blueprints from a Google Cloud Storage bucket.
• Azure Blob Storage - Resolves child blueprints from Azure Blob Storage.

Usage

import (
    "context"

	"github.com/spf13/afero"
    "github.com/two-hundred/celerity/libs/blueprint-resolvers/router"
    "github.com/two-hundred/celerity/libs/blueprint-resolvers/fs"
    "github.com/two-hundred/celerity/libs/blueprint-resolvers/s3"
    "github.com/two-hundred/celerity/libs/blueprint-resolvers/gcs"
    "github.com/two-hundred/celerity/libs/blueprint-resolvers/azure"
    "github.com/two-hundred/celerity/libs/blueprint/subengine"
    "github.com/two-hundred/celerity/libs/blueprint/core"
)

func main() {
    osfs := afero.NewOsFs()
    fsResolver := fs.NewResolver(osfs)

    // nil endpoint resolver will use the default endpoint,
    // credentials will be configured using the default AWS SDK
    // credential chain that will pick up environment variables,
    // shared credentials file, or IAM role.
    s3Resolver := s3.NewResolver(nil)

    // Create a new router that allows for multiple resolvers
    // to be used to resolve child blueprints based on a `sourceType`
    // property in the metadata of an include.
    r := router.NewResolver(
        fsResolver,
        router.WithRoute("aws/s3", s3Resolver),
    )

    // Resolve a child blueprint
    path := "core-infra/blueprints/childBlueprint1.yaml"
    sourceType := "aws/s3"
    bucket := "my-bucket"
    child, err := r.Resolve(
        context.Background(),
        "childBlueprint1",
        &subengine.ResolvedInclude{
            Path: &core.MappingNode{
                Literal: &core.ScalarValue{
                    StringValue: &path,
                },
            },
            Metadata: &core.MappingNode{
                Fields: map[string]*core.MappingNode{
                    "sourceType": {
                        Literal: &core.ScalarValue{
                            StringValue: &sourceType,
                        },
                    },
                    "bucket": {
                        Literal: &core.ScalarValue{
                            StringValue: &bucket,
                        },
                    },
                },
            },
        },
    )
    if err != nil {
        // Handle error
    }

    // Process the resolved child blueprint ...
}

Additional documentation

• Contributing