content

Documentation

Index

• Constants

Constants

const (
	//CmdCloudUse command
	CmdCloudUse = "cloud"

	//CmdCloudShort short description
	CmdCloudShort = "Manage Cloud Accounts"

	//CmdCloudLong long description
	CmdCloudLong = `Connect to your cloud accounts.`

	//CmdCloudListShort short description
	CmdCloudListShort = "Show list of tokens"

	//CmdCloudListLong long description
	CmdCloudListLong = `Show list of tokens.`

	//CmdCloudAddShort short description
	CmdCloudAddShort = "Add a cloud account"

	//CmdCloudAddLong long description
	CmdCloudAddLong = `` /* 541-byte string literal not displayed */

	//CmdCloudScanShort short description
	CmdCloudScanShort = "Scan your root account and create skeletons"

	//CmdCloudScanLong long description
	CmdCloudScanLong = "Scan your root account, get organization and create skeletons for each account"

	//CmdCloudAddExample ...
	CmdCloudAddExample = `` /* 177-byte string literal not displayed */

	//CmdCloudShowShort short description
	CmdCloudShowShort = "Show a cloud account"

	//CmdCloudShowLong long description
	CmdCloudShowLong = `Show a cloud account.`

	//CmdCloudDeleteShort short desription
	CmdCloudDeleteShort = "Delete a cloud account"

	//CmdCloudDeleteLong long desription
	CmdCloudDeleteLong = `Delete a cloud account.`

	//CmdFlagCloudIDLong flag
	CmdFlagCloudIDLong = "cloud-id"

	//CmdFlagRoleName is the name of the role to add a cloud account
	CmdFlagRoleName = "role"

	//CmdFlagRoleNameDescription is description for --role
	CmdFlagRoleNameDescription = "The name of the role you want to create"

	//CmdFlagRoleArn is flag for the Arn of the role you'd like to add for a new cloud account
	CmdFlagRoleArn = "arn"

	//CmdFlagRoleArnDescription is description for --arn
	CmdFlagRoleArnDescription = "The arn of the role to connect"

	//CmdFlagRoleExternalID is flag for external-id used to assume the provided role
	CmdFlagRoleExternalID = "external-id"

	CmdFlagRoleSessionName = "role-session"

	CmdFlagRoleSessionNameDescription = "The session name to assume the role"

	CmdFlagDuration = "duartion"

	CmdFlagDurationDescription = "The duration for session in seconds"

	//CmdFlagAwsProfile = "aws-profile"
	CmdFlagAwsProfile = "aws-profile"

	//CmdFlagAwsProfileDescription ...
	CmdFlagAwsProfileDescription = "Aws shared credential file. If empty default provider chain will be used to look for credentials with the following order.\n" +
		"  1. Environment variables.\n" + "  2. Shared credentials file.\n" + "  3. If your application is running on an Amazon EC2 instance, IAM role for Amazon EC2."

	//CmdFlagAwsProfilePath  ...
	CmdFlagAwsProfilePath = "aws-profile-path"

	//CmdFlagAwsProfilePathDescription ...
	CmdFlagAwsProfilePathDescription = "The file path of aws profile. If empty will look for AWS_SHARED_CREDENTIALS_FILE env variable. " +
		"If the env value is empty will default to current user's home directory.\n" + "  Linux/OSX: \"$HOME/.aws/credentials\"\n" + "  Windows:   \"%USERPROFILE%\\.aws\\credentials\""

	//CmdFlagAwsPolicy is the flag for policy
	CmdFlagAwsPolicy = "policy-arn"

	//CmdFlagAwsPolicyDefault is the default policy arn cli will use
	CmdFlagAwsPolicyDefault = "arn:aws:iam::aws:policy/SecurityAudit"

	//CmdFlagAwsPolicyDescription describes flag policy-arn
	CmdFlagAwsPolicyDescription = "The arn of the policy you'd like to attach for role creation, SecurityAudit policy arn by default"

	CmdFlagIsDraft = "draft"

	CmdFlagIsDraftDescription = "Create a draft"

	CmdFlagUserName = "username"

	CmdFlagUserNameDescription = "User name of account owner"

	CmdFlagEnvironmentShort       = "e"
	CmdFlagEnvironmentLong        = "environment"
	CmdFlagEnvironmentDescription = "Environment label for cloud account, four options available: Production, Staging, Development, Test"

	CmdFlagEmail = "email"

	CmdFlagEmailDescription = "Email address of account owner"

	CmdFlagAwsAssumeRolePolicy = "policy"

	CmdFlagAwsAssumeRolePolicyDescription = "The policy you'd like to use to assume that role"

	CmdFlagAwsAssumeRolePolicyDefault = "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":\"organizations:*\",\"Resource\":\"*\"}]}"

	//CmdFlagRoleExternalIDDescription is description for flag --external-id
	CmdFlagRoleExternalIDDescription = "The external-id used to assume the provided role"

	//CmdFlagCloudIDDescription flag description
	CmdFlagCloudIDDescription = "Coreo cloud id"

	//InfoCloudAccountDeleted info
	InfoCloudAccountDeleted = "Cloud account was deleted"

	//InfoUsingCloudAccount info
	InfoUsingCloudAccount = "[ OK ] Using Cloud Account ID %s\n"

	//ErrorCloudIDRequired error message
	ErrorCloudIDRequired = "Cloud Account ID is required for this command. Use flag '--cloud-id'\n"

	//CmdFlagLevelLong is flag --severity
	CmdFlagLevelLong = "severity"

	//CmdFlagLevelDescription is description for flag --severity
	CmdFlagLevelDescription = "The severity level you'd like to show in violation results"
)

const (
	//CmdCompletionUse docs command
	CmdCompletionUse = "completion"

	//CmdCompletionShort short description
	CmdCompletionShort = "Generate bash autocompletions script"

	//CmdCompletionLong long description
	CmdCompletionLong = `` /* 175-byte string literal not displayed */

)

const (
	//CmdConfigureShort short description
	CmdConfigureShort = "Configure CLI options"

	//CmdConfigureLong long description
	CmdConfigureLong = `` /* 795-byte string literal not displayed */

	//CmdConfigureExample is examples for coreo configure command
	CmdConfigureExample = `` /* 136-byte string literal not displayed */

	//CmdConfigurePromptAPIKEY prompt for api key
	CmdConfigurePromptAPIKEY = "Enter your CloudCoreo api token key (available on https://app.cloudcoreo.com under Settings -> API Tokens) [%s]: "

	//CmdConfigurePromptSecretKEY prompt for secret key
	CmdConfigurePromptSecretKEY = "Enter your CloudCoreo api token secret key (available on https://app.cloudcoreo.com under Settings -> API Tokens) [%s]: "

	//CmdConfigurePromptTeamID prompt for team ID
	CmdConfigurePromptTeamID = "Enter your default CloudCoreo team ID (available on https://app.cloudcoreo.com under Settings -> Team) [%s]: "

	//CmdConfigureListShort short description
	CmdConfigureListShort = "List all user profiles"

	//CmdConfigureListLong long description
	CmdConfigureListLong = `List all user profiles.`
)

const (
	//CmdFlagTypeLong cmd
	CmdFlagTypeLong = "type"

	//CmdFlagTypeShort cmd
	CmdFlagTypeShort = "t"

	//CmdFlagTypeDescription cmd
	CmdFlagTypeDescription = "the type of documentation to generate (markdown, man, bash)"

	//CmdDocsUse docs command
	CmdDocsUse = "docs"

	//CmdDocsShort short description
	CmdDocsShort = "Generate documentation as markdown or man pages"

	//CmdDocsLong long description
	CmdDocsLong = `` /* 224-byte string literal not displayed */

	//ErrorDocGeneration description
	ErrorDocGeneration = "unknown doc type %q. Try 'markdown' or 'man'"
)

const (
	//CmdLintUse command
	CmdLintUse = "coreo lint [flags] PATH"

	//CmdLintShort short description
	CmdLintShort = "examines a composite for possible issues"

	//CmdLintLong long description
	CmdLintLong = `` /* 342-byte string literal not displayed */

)

const (
	//CmdResultUse ...
	CmdResultUse = "result"

	//CmdResultShort ...
	CmdResultShort = "Show the violation results"

	//CmdResultLong ...
	CmdResultLong = "Show the violation results"

	//CmdResultRuleUse ...
	CmdResultRuleUse = "rule"

	//CmdResultRuleShort ...
	CmdResultRuleShort = "Show violating rules"

	//CmdResultRuleLong ...
	CmdResultRuleLong = "Show violating rules"

	//CmdResultObjectUse ...
	CmdResultObjectUse = "object"

	//CmdResultObjectShort ...
	CmdResultObjectShort = "Show violating objects"

	//CmdResultObjectLong ...
	CmdResultObjectLong = "Show violating objects"

	//CmdResultRuleExample ...
	CmdResultRuleExample = `` /* 171-byte string literal not displayed */

	//CmdResultObjectExample ...
	CmdResultObjectExample = `` /* 175-byte string literal not displayed */

)

const (
	//AccessKey api key
	AccessKey = "API_KEY"

	//SecretKey secret key
	SecretKey = "SECRET_KEY"

	//TeamID team id
	TeamID = "TEAM_ID"

	//DefaultFolder defautl folder
	DefaultFolder = ".cloudcoreo"

	//DefaultFile default file
	DefaultFile = "profiles.yaml"

	//None none
	None = "None"

	//MaskLength mask length
	MaskLength = 4

	//Mask mask
	Mask = "****************"

	//ErrorMissingFile error
	ErrorMissingFile = "Missing %s file, creating it.\n"

	//ErrorDirectoryPathNotProvided error
	ErrorDirectoryPathNotProvided = "Directory path not provided.\n"

	//ErrorGitURLNotProvided error
	ErrorGitURLNotProvided = "Git url not provided. Use flag -g\n"

	//ErrorInvalidDirectory error
	ErrorInvalidDirectory = "Error switching to directory to %s. Please make sure it's a valid directory.\n"

	//ErrorGitSubmoduleFailed error
	ErrorGitSubmoduleFailed = "git submodule add failed with:\n%s\n"

	//ErrorGitRepoURLMissing error
	ErrorGitRepoURLMissing = "A SSH git repo url is required: -g\n"

	//ErrorInvalidGitRepoURL error
	ErrorInvalidGitRepoURL = "Use a SSH git repo url for example : [-g git@github.com:CloudCoreo/audit-aws.git]\n"

	//ErrorNameMissing error
	ErrorNameMissing = "Name is required for this command. Use flag --name\n"

	//ErrorKeyMissing error
	ErrorKeyMissing = "Key is required for this command. Use flag --key\n"

	//ErrorAPIKeyMissing error
	ErrorAPIKeyMissing = "Coreo API Key is required for this command. Use flag --api-key\n"

	//ErrorSecretMissing error
	ErrorSecretMissing = "Secret is required for this command. Use flag --secret\n"

	//ErrorAPISecretMissing error
	ErrorAPISecretMissing = "API Secret is required for this command. Use flag --api-secret\n"

	//ErrorGitInitNotRan error
	ErrorGitInitNotRan = "Not a git repository (or any of the parent directories): .git\n"

	//ErrorNoUserProfileFound error
	ErrorNoUserProfileFound = "No user profile found. Set profile using 'coreo configure' command"

	//ErrorAcceptsNoArgs error
	ErrorAcceptsNoArgs = "This command accepts no argument(s).\n"

	//InfoCreatingGitSubmodule info
	InfoCreatingGitSubmodule = "Creating gitsubmodule %s in %s...\n"

	//CmdFlagDirectoryLong cmd
	CmdFlagDirectoryLong = "directory"

	//CmdFlagDirectoryShort cmd
	CmdFlagDirectoryShort = "d"

	//CmdFlagDirectoryDescription cmd
	CmdFlagDirectoryDescription = "The working directory <fully-qualified-path>"

	//CmdFlagNameLong cmd
	CmdFlagNameLong = "name"

	//CmdFlagNameShort cmd
	CmdFlagNameShort = "n"

	//CmdFlagDescriptionLong cmd
	CmdFlagDescriptionLong = "description"

	//CmdFlagDescriptionShort cmd
	CmdFlagDescriptionShort = "d"

	//CmdFlagNameDescription cmd
	CmdFlagNameDescription = "Name flag"

	//CmdFlagKeyLong cmd
	CmdFlagKeyLong = "key"

	//CmdFlagKeyShort cmd
	CmdFlagKeyShort = "K"

	//CmdFlagKeyDescription cmd
	CmdFlagKeyDescription = "Resource key"

	//CmdFlagSecretLong secret flag long
	CmdFlagSecretLong = "secret"

	//CmdFlagSecretShort secret flag short
	CmdFlagSecretShort = "S"

	//CmdFlagSecretDescription secret flag description
	CmdFlagSecretDescription = "Resource secret"

	//CmdFlagAPISecretLong secret flag long
	CmdFlagAPISecretLong = "api-secret"

	//CmdFlagAPISecretDescription api secret flag description
	CmdFlagAPISecretDescription = "Coreo API Secret"

	//CmdFlagAPIKeyLong api key flag long
	CmdFlagAPIKeyLong = "api-key"

	//CmdFlagAPIKeyDescription api key flag description
	CmdFlagAPIKeyDescription = "Coreo API Key"

	//CmdFlagTeamIDLong team id long
	CmdFlagTeamIDLong = "team-id"

	//CmdFlagTeamIDDescription team id flag description
	CmdFlagTeamIDDescription = "Coreo team id"

	//CmdFlagJSONLong json long
	CmdFlagJSONLong = "json"

	//CmdFlagJSONDescription json flag description
	CmdFlagJSONDescription = "Output in json format"

	//CmdFlagVerboseLong verbose long
	CmdFlagVerboseLong = "verbose"

	//CmdFlagVerboseDescription verbose flag description
	CmdFlagVerboseDescription = "Enable verbose output"

	//CmdFlagFileLong JSON file flag
	CmdFlagFileLong = "file"

	//CmdFlagFileShort JSON file flag
	CmdFlagFileShort = "f"

	//CmdFlagConfigLong config flag long
	CmdFlagConfigLong = "home"

	//CmdFlagConfigDescription config flag description
	CmdFlagConfigDescription = "Location of your Coreo config. Overrides $COREO_HOME."

	//CmdFlagProfileLong profile flag long
	CmdFlagProfileLong = "profile"

	//CmdFlagProfileDescription secret flag description
	CmdFlagProfileDescription = "Coreo profile to use. Overrides $COREO_PROFILE."

	//CmdFlagAPIEndpointLong api endpoint flag long
	CmdFlagAPIEndpointLong = "endpoint"

	//CmdFlagAPIEndpointDescription api endpoint description
	CmdFlagAPIEndpointDescription = "Coreo API endpoint. Overrides $CC_API_ENDPOINT."

	//CmdCoreoUse Coreo cmd
	CmdCoreoUse = "coreo"

	//CmdCoreoShort Coreo short description
	CmdCoreoShort = "CloudCoreo CLI"

	//CmdCoreoLong Coreo long description
	CmdCoreoLong = `CloudCoreo CLI.`

	//CmdConfigureUse configure cmd
	CmdConfigureUse = "configure"

	//CmdListUse list cmd
	CmdListUse = "list"

	//CmdAddUse add cmd
	CmdAddUse = "add"

	//CmdScanUse scan cmd
	CmdScanUse = "scan"

	//CmdDeleteUse delete cmd
	CmdDeleteUse = "delete [flags]"

	//CmdShowUse show cmd
	CmdShowUse = "show [flags]"

	//InfoUsingProfile info using profile
	InfoUsingProfile = "[ OK ] Using Profile %s\n"

	//InfoCommandSuccess info command was executed successfully
	InfoCommandSuccess = "[ OK ] Command was executed successfully"
)

const (
	//CmdTeamUse team command
	CmdTeamUse = "team"

	//CmdTeamShort short description
	CmdTeamShort = "Manage Teams"

	//CmdTeamLong long description
	CmdTeamLong = `Manage Teams.`

	//CmdTeamListShort short description
	CmdTeamListShort = "Show list of team"

	//CmdTeamListLong long description
	CmdTeamListLong = `Show list of team.`

	//CmdTeamListExample is the use case for command team list
	CmdTeamListExample = "coreo team list"

	//CmdTeamShowShort short description
	CmdTeamShowShort = "Show a team"

	//CmdTeamShowLong long description
	CmdTeamShowLong = `Show a team.`

	//CmdTeamAddShort add a team short description
	CmdTeamAddShort = "Add a team"

	//CmdTeamAddLong add a team long description
	CmdTeamAddLong = `Add a team.`

	//CmdTeamNameDescription provide team name
	CmdTeamNameDescription = "Provide team name"

	//CmdTeamDescriptionDescription provide team description
	CmdTeamDescriptionDescription = "Provide team description"

	//InfoUsingTeamID informational using team id
	InfoUsingTeamID = "[ OK ] Using Team ID %s\n"

	//ErrorTeamIDMissing error
	ErrorTeamIDMissing = "Team ID is required for this command. Use flag --team-id\n"

	//ErrorTeamNameRequired error
	ErrorTeamNameRequired = "Team Name is required for this command. Use flag --name\n"

	//ErrorTeamDescriptionRequired error
	ErrorTeamDescriptionRequired = "Team description required for this command. Use flag --description\n"
)

const (
	//CmdTokenUse token command
	CmdTokenUse = "token"

	//CmdTokenShort short description
	CmdTokenShort = "Manage API Tokens"

	//CmdTokenLong long description
	CmdTokenLong = `Manage API Tokens.`

	//CmdTokenListShort short description
	CmdTokenListShort = "Show list of tokens"

	//CmdTokenListLong long description
	CmdTokenListLong = `Show list of tokens.`

	//CmdTokenAddShort short description
	CmdTokenAddShort = "Add a token"

	//CmdTokenAddLong long description
	CmdTokenAddLong = `Add a token.`

	//CmdTokenShowShort short description
	CmdTokenShowShort = "Show a token"

	//CmdTokenShowLong long description
	CmdTokenShowLong = `Show a token.`

	//CmdTokenDeleteShort short description
	CmdTokenDeleteShort = "Delete a token"

	//CmdTokenDeleteLong long description
	CmdTokenDeleteLong = `Delete a token.`

	//CmdFlagTokenIDLong flag
	CmdFlagTokenIDLong = "token-id"

	//CmdFlagTokenIDDescription flag description
	CmdFlagTokenIDDescription = "Coreo token id"

	//InfoUsingTokenID informational using Token id
	InfoUsingTokenID = "[ OK ] Using Token ID %s\n"

	//InfoTokenDeleted information
	InfoTokenDeleted = "[ DONE ] Token was deleted.\n"

	//ErrorTokenIDMissing error
	ErrorTokenIDMissing = "Token ID is required for this command. Use flag --token-id\n"
)

const (
	// CmdVersionUse command
	CmdVersionUse = "version"

	//CmdVersionShort command
	CmdVersionShort = "Print the version number of Coreo CLI"

	//CmdVersionLong command
	CmdVersionLong = `Print the version number of Coreo CLI.`
)

const CmdEventLong = "Manage event stream"

CmdEventLong is the long version description for coreo event command

const CmdEventSetupExample = `  coreo event setup
  coreo event setup --aws-profile YOUR_AWS_PROFILE --cloud-id YOUR_CLOUD_ID`

CmdEventSetupExample is the use case for command event setup

const CmdEventSetupLong = "Run this command to setup event stream. " +
	"It will create a CloudFormation stack with an event rule and SNS topic. " +
	"You will need to run this script for each cloud account. " +
	"Make sure your aws credentials have been configured before run this command."

CmdEventSetupLong is the long version description for coreo event setup command

const CmdEventSetupShort = "Setup event stream"

CmdEventSetupShort is the short version description for coreo event setup command

const CmdEventSetupUse = "setup"

CmdEventSetupUse is a command to setup event stream

const CmdEventShort = "Manage event stream"

CmdEventShort is the short version description for coreo event command

const CmdEventUse = "event"

CmdEventUse is command for event stream