Documentation
¶
Index ¶
- func GetVarsFileOptions(files []string) ([]string, error)
- func GetVarsOptions(vars []string) ([]string, error)
- func Login(runner command.ExecRunner, options LoginOptions) error
- func Logout(runner command.ExecRunner) error
- func ReadManifest(name string) (*manifest, error)
- func ReadServiceKey(runner command.ExecRunner, options ServiceKeyOptions) (serviceKey string, err error)
- type LoginOptions
- type ServiceKeyOptions
- type VarsFilesNotFoundError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetVarsFileOptions ¶ added in v1.86.0
GetVarsFileOptions returns the CF CLI options for existing variable files. If any requested file is missing, the returned error is a VarsFilesNotFoundError and the options still include the files that exist.
func GetVarsOptions ¶ added in v1.86.0
GetVarsOptions returns the CF CLI options for variable assignments in key=value form.
func Login ¶
func Login(runner command.ExecRunner, options LoginOptions) error
Login logs the current user in to Cloud Foundry with username/password credentials.
func Logout ¶
func Logout(runner command.ExecRunner) error
Logout logs the current user out of Cloud Foundry.
func ReadManifest ¶ added in v1.45.0
ReadManifest Reads the manifest denoted by 'name'
func ReadServiceKey ¶ added in v1.529.0
func ReadServiceKey(runner command.ExecRunner, options ServiceKeyOptions) (serviceKey string, err error)
ReadServiceKey returns the JSON service key for the specified service instance.
Types ¶
type LoginOptions ¶
type LoginOptions struct {
CfAPIEndpoint string
CfOrg string
CfSpace string
Username string
Password string
CfLoginOpts []string
}
LoginOptions contains the Cloud Foundry target and authentication details.
type ServiceKeyOptions ¶
type ServiceKeyOptions struct {
CfAPIEndpoint string
CfOrg string
CfSpace string
CfServiceInstance string
CfServiceKeyName string
Username string
Password string
}
ServiceKeyOptions identifies a Cloud Foundry service key and the target where it resides.
type VarsFilesNotFoundError ¶ added in v1.86.0
VarsFilesNotFoundError reports the variable files that were not found.
func (*VarsFilesNotFoundError) Error ¶ added in v1.86.0
func (e *VarsFilesNotFoundError) Error() string
Source Files