README
¶
Go Cloud Foundry Environment Package (cfenv)
Overview
cfenv is a package to assist you in writing Go apps that run on Cloud Foundry. It provides convenience functions and structures that map to Cloud Foundry environment variable primitives (http://docs.cloudfoundry.com/docs/using/deploying-apps/environment-variable.html).
Build Status
Master
Develop
Usage
go get github.com/cloudfoundry-community/go-cfenv
package main
import (
"github.com/cloudfoundry-community/go-cfenv"
)
func main() {
appEnv := cfenv.Current()
fmt.Println("ID:", appEnv.ID)
fmt.Println("Index:", appEnv.Index)
fmt.Println("Name:", appEnv.Name)
fmt.Println("Host:", appEnv.Host)
fmt.Println("Port:", appEnv.Port)
fmt.Println("Version:", appEnv.Version)
fmt.Println("Home:", appEnv.Home)
fmt.Println("MemoryLimit:", appEnv.MemoryLimit)
fmt.Println("WorkingDir:", appEnv.WorkingDir)
fmt.Println("TempDir:", appEnv.TempDir)
fmt.Println("User:", appEnv.User)
fmt.Println("Services:", appEnv.Services)
}
Contributing
Pull requests welcomed. Please ensure you make your changes in a branch off of the develop branch, not the master branch.
Documentation
¶
Overview ¶
Package cfenv provides information about the current app deployed on Cloud Foundry, including any bound service(s).
Index ¶
- func CurrentEnv() map[string]string
- func Env(env []string) map[string]string
- type App
- type Service
- type Services
- func (s *Services) WithLabel(label string) ([]Service, error)
- func (s *Services) WithName(name string) (*Service, error)
- func (s *Services) WithNameUsingPattern(namePattern string) ([]Service, error)
- func (s *Services) WithTag(tag string) ([]Service, error)
- func (s *Services) WithTagUsingPattern(tagPattern string) ([]Service, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CurrentEnv ¶
CurrentEnv translates the current environment to a map[string]string.
Types ¶
type App ¶
type App struct {
ID string `json:"instance_id"` // id of the app
Index int `json:"instance_index"` // index of the app
Name string `json:"name"` // name of the app
Host string `json:"host"` // host of the app
Port int `json:"port"` // port of the app
Version string `json:"version"` // version of the app
ApplicationURIs []string `json:"application_uris"` // application uri of the app
Home string // root folder for the deployed app
MemoryLimit string // maximum amount of memory that each instance of the application can consume
WorkingDir string // present working directory, where the buildpack that processed the application ran
TempDir string // directory location where temporary and staging files are stored
User string // user account under which the DEA runs
Services Services // services bound to the app
}
An App holds information about the current app running on Cloud Foundry
type Service ¶
type Service struct {
Name string // name of the service
Label string // label of the service
Tags []string // tags for the service
Plan string // plan of the service
Credentials map[string]interface{} // credentials for the service
}
Service describes a bound service. For bindable services Cloud Foundry will add connection details to the VCAP_SERVICES environment variable when you restart your application, after binding a service instance to your application.
The results are returned as a JSON document that contains an object for each service for which one or more instances are bound to the application. The service object contains a child object for each service instance of that service that is bound to the application.
type Services ¶
Services is an association of service labels to a slice of services with that label.
func (*Services) WithNameUsingPattern ¶
WithName finds the service with a name pattern.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Godeps
|
|
|
_workspace/src/github.com/mitchellh/mapstructure
The mapstructure package exposes functionality to convert an abitrary map[string]interface{} into a native Go structure.
|
The mapstructure package exposes functionality to convert an abitrary map[string]interface{} into a native Go structure. |
|
_workspace/src/github.com/onsi/ginkgo
Ginkgo is a BDD-style testing framework for Golang
|
Ginkgo is a BDD-style testing framework for Golang |
|
_workspace/src/github.com/onsi/ginkgo/config
Ginkgo accepts a number of configuration options.
|
Ginkgo accepts a number of configuration options. |
|
_workspace/src/github.com/onsi/ginkgo/ginkgo
command
The Ginkgo CLI
|
The Ginkgo CLI |
|
_workspace/src/github.com/onsi/ginkgo/ginkgo/aggregator
Aggregator is a reporter used by the Ginkgo CLI to aggregate and present parallel test output as one coherent stream.
|
Aggregator is a reporter used by the Ginkgo CLI to aggregate and present parallel test output as one coherent stream. |
|
_workspace/src/github.com/onsi/ginkgo/ginkgo/support/fsnotify
Package fsnotify implements filesystem notification.
|
Package fsnotify implements filesystem notification. |
|
_workspace/src/github.com/onsi/ginkgo/reporters
Ginkgo's Default Reporter
|
Ginkgo's Default Reporter |
|
_workspace/src/github.com/onsi/ginkgo/thirdparty/gomocktestreporter
The gomocktestreporter package provides a Ginkgo friendly implementation of [Gomock's](https://code.google.com/p/gomock/) `TestReporter` interface.
|
The gomocktestreporter package provides a Ginkgo friendly implementation of [Gomock's](https://code.google.com/p/gomock/) `TestReporter` interface. |
|
_workspace/src/github.com/onsi/gomega
Gomega is the Ginkgo BDD-style testing framework's preferred matcher library.
|
Gomega is the Ginkgo BDD-style testing framework's preferred matcher library. |
|
_workspace/src/github.com/onsi/gomega/matchers
Gomega matchers
|
Gomega matchers |