project

package
v1.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 23, 2019 License: MIT Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ReadProjectFile

func ReadProjectFile(dir fs.Directory) ([]byte, error)

ReadProjectFile reads a project.yml file from a given directory.

Types

type Config

type Config struct {
	Directory   fs.Directory
	Name        string                    `yaml:"name"`
	Description string                    `yaml:"description"`
	Products    map[string]product.Config `yaml:"products"`
	Network     Network                   `yaml:"network"`
}

Config holds project-related configuration information.

func Load

func Load(dir fs.Directory) (Config, error)

Load loads a project and returns a Project struct instance for manipulating the project.

func NewProject

func NewProject(dir fs.Directory, track bool) (Config, error)

NewProject creates a project in the specified directory and adds it to the tracked projects if track is specified.

type Network

type Network struct {
	Name   string            `yaml:"name"`
	Labels map[string]string `yaml:"labels"`
}

Network is a representation of a "network" entity within the deployment platform.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL