Documentation
¶
Index ¶
- Variables
- type AddASGToConfigurationCommand
- type AddOrgToConfigurationCommand
- type AddSpaceToConfigurationCommand
- type BaseConfigCommand
- type CfMgmtConfigCommand
- type DeleteOrgConfigurationCommand
- type DeleteSpaceConfigurationCommand
- type GenerateConcoursePipelineCommand
- type InitConfigurationCommand
- type OrgQuota
- type SpaceQuota
- type UpdateOrgConfigurationCommand
- type UpdateSpaceConfigurationCommand
- type UserRole
- type UserRoleAdd
- type VersionCommand
Constants ¶
This section is empty.
Variables ¶
View Source
var VERSION = "0.0.0-dev"
Functions ¶
This section is empty.
Types ¶
type AddASGToConfigurationCommand ¶ added in v0.0.72
type AddASGToConfigurationCommand struct {
ConfigManager config.Manager
BaseConfigCommand
ASGName string `long:"asg" description:"ASG name" required:"true"`
FilePath string `long:"path" description:"path to asg definition"`
Override bool `long:"override" description:"override current definition"`
}
func (*AddASGToConfigurationCommand) Execute ¶ added in v0.0.72
func (c *AddASGToConfigurationCommand) Execute([]string) error
Execute - adds a named asg to the configuration
type AddOrgToConfigurationCommand ¶
type AddOrgToConfigurationCommand struct {
ConfigManager config.Manager
BaseConfigCommand
OrgName string `long:"org" description:"Org name" required:"true"`
PrivateDomains []string `long:"private-domain" description:"Private Domain(s) to add, specify multiple times"`
DefaultIsolationSegment string `long:"default-isolation-segment" description:"Default isolation segment for org" `
Quota OrgQuota `group:"quota"`
BillingManager UserRoleAdd `group:"billing-manager" namespace:"billing-manager"`
Manager UserRoleAdd `group:"manager" namespace:"manager"`
Auditor UserRoleAdd `group:"auditor" namespace:"auditor"`
}
func (*AddOrgToConfigurationCommand) Execute ¶
func (c *AddOrgToConfigurationCommand) Execute([]string) error
Execute - adds a named org to the configuration
type AddSpaceToConfigurationCommand ¶
type AddSpaceToConfigurationCommand struct {
ConfigManager config.Manager
BaseConfigCommand
OrgName string `long:"org" description:"Org name" required:"true"`
SpaceName string `long:"space" description:"Space name" required:"true"`
AllowSSH string `long:"allow-ssh" description:"Enable the Space Quota in the config" choice:"true" choice:"false"`
EnableSecurityGroup string `long:"enable-security-group" description:"Enable space level security group definitions" choice:"true" choice:"false"`
IsoSegment string `long:"isolation-segment" description:"Isolation segment assigned to space"`
ASGs []string `long:"named-asg" description:"Named asg(s) to assign to space, specify multiple times"`
Quota SpaceQuota `group:"quota"`
Developer UserRoleAdd `group:"developer" namespace:"developer"`
Manager UserRoleAdd `group:"manager" namespace:"manager"`
Auditor UserRoleAdd `group:"auditor" namespace:"auditor"`
}
func (*AddSpaceToConfigurationCommand) Execute ¶
func (c *AddSpaceToConfigurationCommand) Execute([]string) error
Execute - adds a named space to the configuration
type BaseConfigCommand ¶
type BaseConfigCommand struct {
ConfigDirectory string `long:"config-dir" env:"CONFIG_DIR" default:"config" description:"Name of the config directory"`
}
BaseConfigCommand - commmand that specifies config-dir
type CfMgmtConfigCommand ¶
type CfMgmtConfigCommand struct {
Version VersionCommand `command:"version" description:"Print version information and exit"`
InitConfigurationCommand InitConfigurationCommand `command:"init" description:"Initializes folder structure for configuration"`
AddOrgToConfigurationCommand AddOrgToConfigurationCommand `command:"add-org" description:"Adds specified org to configuration"`
AddSpaceToConfigurationCommand AddSpaceToConfigurationCommand `command:"add-space" description:"Adds specified space to configuration for org"`
GenerateConcoursePipelineCommand GenerateConcoursePipelineCommand `command:"generate-concourse-pipeline" description:"generates a concourse pipline to be used to drive cf-mgmt"`
UpdateOrgConfigurationCommand UpdateOrgConfigurationCommand `command:"update-org" description:"updates org configuration"`
UpdateSpaceConfigurationCommand UpdateSpaceConfigurationCommand `command:"update-space" description:"updates space configuration"`
DeleteOrgConfigurationCommand DeleteOrgConfigurationCommand `command:"delete-org" description:"deletes org configuration"`
DeleteSpaceConfigurationCommand DeleteSpaceConfigurationCommand `command:"delete-space" description:"deletes space configuration"`
AddASGToConfigurationCommand AddASGToConfigurationCommand `command:"add-asg" description:"add a named asg to configuration"`
}
var CfMgmtConfig CfMgmtConfigCommand
type DeleteOrgConfigurationCommand ¶
type DeleteOrgConfigurationCommand struct {
BaseConfigCommand
OrgName string `long:"org" description:"Org name to delete" required:"true"`
ConfirmDeletion bool `long:"confirm-deletion" description:"Confirm Deletion" required:"true"`
}
func (*DeleteOrgConfigurationCommand) Execute ¶
func (c *DeleteOrgConfigurationCommand) Execute([]string) error
Execute - deletes org from config
type DeleteSpaceConfigurationCommand ¶
type DeleteSpaceConfigurationCommand struct {
BaseConfigCommand
OrgName string `long:"org" description:"Org name of space to delete" required:"true"`
SpaceName string `long:"space" description:"Space name to delete" required:"true"`
ConfirmDeletion bool `long:"confirm-deletion" description:"Confirm Deletion" required:"true"`
}
func (*DeleteSpaceConfigurationCommand) Execute ¶
func (c *DeleteSpaceConfigurationCommand) Execute([]string) error
Execute - deletes space from config
type GenerateConcoursePipelineCommand ¶
type GenerateConcoursePipelineCommand struct {
}
func (*GenerateConcoursePipelineCommand) Execute ¶
func (c *GenerateConcoursePipelineCommand) Execute([]string) error
Execute - generates concourse pipeline and tasks
type InitConfigurationCommand ¶
type InitConfigurationCommand struct {
BaseConfigCommand
}
func (*InitConfigurationCommand) Execute ¶
func (c *InitConfigurationCommand) Execute([]string) error
Execute - initializes cf-mgmt configuration
type OrgQuota ¶ added in v0.0.71
type OrgQuota struct {
EnableOrgQuota string `long:"enable-org-quota" description:"Enable the Org Quota in the config" choice:"true" choice:"false"`
MemoryLimit string `long:"memory-limit" description:"An Org's memory limit in Megabytes"`
InstanceMemoryLimit string `long:"instance-memory-limit" description:"Global Org Application instance memory limit in Megabytes"`
TotalRoutes string `long:"total-routes" description:"Total Routes capacity for an Org"`
TotalServices string `long:"total-services" description:"Total Services capacity for an Org"`
PaidServicesAllowed string `long:"paid-service-plans-allowed" description:"Allow paid services to appear in an org" choice:"true" choice:"false"`
TotalPrivateDomains string `long:"total-private-domains" description:"Total Private Domain capacity for an Org"`
TotalReservedRoutePorts string `long:"total-reserved-route-ports" description:"Total Reserved Route Ports capacity for an Org"`
TotalServiceKeys string `long:"total-service-keys" description:"Total Service Keys capacity for an Org"`
AppInstanceLimit string `long:"app-instance-limit" description:"Total Service Keys capacity for an Org"`
}
type SpaceQuota ¶ added in v0.0.71
type SpaceQuota struct {
EnableSpaceQuota string `long:"enable-space-quota" description:"Enable the Space Quota in the config" choice:"true" choice:"false"`
MemoryLimit string `long:"memory-limit" description:"An Space's memory limit in Megabytes"`
InstanceMemoryLimit string `long:"instance-memory-limit" description:"Space Application instance memory limit in Megabytes"`
TotalRoutes string `long:"total-routes" description:"Total Routes capacity for an Space"`
TotalServices string `long:"total-services" description:"Total Services capacity for an Space"`
PaidServicesAllowed string `long:"paid-service-plans-allowed" description:"Allow paid services to appear in an Space" choice:"true" choice:"false"`
TotalPrivateDomains string `long:"total-private-domains" description:"Total Private Domain capacity for an Space"`
TotalReservedRoutePorts string `long:"total-reserved-route-ports" description:"Total Reserved Route Ports capacity for an Space"`
TotalServiceKeys string `long:"total-service-keys" description:"Total Service Keys capacity for an Space"`
AppInstanceLimit string `long:"app-instance-limit" description:"Total Service Keys capacity for an Space"`
}
type UpdateOrgConfigurationCommand ¶
type UpdateOrgConfigurationCommand struct {
ConfigManager config.Manager
BaseConfigCommand
OrgName string `long:"org" description:"Org name" required:"true"`
PrivateDomains []string `long:"private-domain" description:"Private Domain(s) to add, specify multiple times"`
PrivateDomainsToRemove []string `long:"private-domain-to-remove" description:"Private Domain(s) to remove, specify multiple times"`
EnableRemovePrivateDomains string `long:"enable-remove-private-domains" description:"Enable removing private domains" choice:"true" choice:"false"`
DefaultIsolationSegment string `long:"default-isolation-segment" description:"Default isolation segment for org" `
ClearDefaultIsolationSegment bool `long:"clear-default-isolation-segment" description:"Sets the default isolation segment to blank"`
EnableRemoveUsers string `long:"enable-remove-users" description:"Enable removing users from the org" choice:"true" choice:"false"`
Quota OrgQuota `group:"quota"`
BillingManager UserRole `group:"billing-manager" namespace:"billing-manager"`
Manager UserRole `group:"manager" namespace:"manager"`
Auditor UserRole `group:"auditor" namespace:"auditor"`
}
func (*UpdateOrgConfigurationCommand) Execute ¶
func (c *UpdateOrgConfigurationCommand) Execute(args []string) error
Execute - updates org configuration`
type UpdateSpaceConfigurationCommand ¶
type UpdateSpaceConfigurationCommand struct {
ConfigManager config.Manager
BaseConfigCommand
OrgName string `long:"org" description:"Org name" required:"true"`
SpaceName string `long:"space" description:"Space name" required:"true"`
AllowSSH string `long:"allow-ssh" description:"Enable the Space Quota in the config" choice:"true" choice:"false"`
EnableRemoveUsers string `long:"enable-remove-users" description:"Enable removing users from the space" choice:"true" choice:"false"`
EnableSecurityGroup string `long:"enable-security-group" description:"Enable space level security group definitions" choice:"true" choice:"false"`
IsoSegment string `long:"isolation-segment" description:"Isolation segment assigned to space"`
ClearIsolationSegment bool `long:"clear-isolation-segment" description:"Sets the isolation segment to blank"`
ASGs []string `long:"named-asg" description:"Named asg(s) to assign to space, specify multiple times"`
ASGsToRemove []string `long:"named-asg-to-remove" description:"Named asg(s) to remove, specify multiple times"`
Quota SpaceQuota `group:"quota"`
Developer UserRole `group:"developer" namespace:"developer"`
Manager UserRole `group:"manager" namespace:"manager"`
Auditor UserRole `group:"auditor" namespace:"auditor"`
}
func (*UpdateSpaceConfigurationCommand) Execute ¶
func (c *UpdateSpaceConfigurationCommand) Execute(args []string) error
Execute - updates space configuration`
type UserRole ¶
type UserRole struct {
UserRoleAdd
LDAPUsersToRemove []string `long:"ldap-user-to-remove" description:"Ldap User to remove, specify multiple times"`
UsersToRemove []string `long:"user-to-remove" description:"User to remove, specify multiple times"`
SamlUsersToRemove []string `long:"saml-user-to-remove" description:"SAML user to remove, specify multiple times"`
LDAPGroupsToRemove []string `long:"ldap-group-to-remove" description:"Group to remove, specify multiple times"`
}
type UserRoleAdd ¶ added in v0.0.71
type UserRoleAdd struct {
LDAPUsers []string `long:"ldap-user" description:"Ldap User to add, specify multiple times"`
Users []string `long:"user" description:"User to add, specify multiple times"`
SamlUsers []string `long:"saml-user" description:"SAML user to add, specify multiple times"`
LDAPGroups []string `long:"ldap-group" description:"Group to add, specify multiple times"`
}
type VersionCommand ¶
type VersionCommand struct {
}
func (*VersionCommand) Execute ¶
func (c *VersionCommand) Execute([]string) error
Execute - returns the version
Click to show internal directories.
Click to hide internal directories.