Documentation
¶
Index ¶
- type AccountPreferences
- type AmbariAddress
- type AmbariDatabaseDetails
- type AmbariDatabaseTestResult
- type AmbariRepoDetailsJSON
- type AmbariStackDetails
- type BlueprintRequest
- type BlueprintResponse
- type CertificateResponse
- type CloudbreakDetailsJSON
- type CloudbreakEvent
- type CloudbreakUsage
- type ClusterRequest
- type ClusterResponse
- type Constraint
- type ConstraintTemplateRequest
- type ConstraintTemplateResponse
- type CredentialRequest
- type CredentialResponse
- type FailurePolicy
- type FileSystem
- type HostGroup
- type HostGroupAdjustment
- type HostMetadata
- type ID
- type ImageJSON
- type InstanceGroup
- type InstanceGroupAdjustment
- type InstanceMetaData
- type LdapConfigRequest
- type LdapConfigResponse
- type NetworkJSON
- type OrchestratorRequest
- type OrchestratorResponse
- type PlatformVariantsJSON
- type RDSConfig
- type RDSConfigResponse
- type RdsTestResult
- type RecipeRequest
- type RecipeResponse
- type SecurityGroupJSON
- type SecurityRule
- type SssdConfigRequest
- type SssdConfigResponse
- type StackRequest
- type StackResponse
- type StackValidationRequest
- type TemplateRequest
- type TemplateResponse
- type TopologyRequest
- type TopologyResponse
- type UpdateCluster
- type UpdateStack
- type User
- type UserNamePasswordJSON
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccountPreferences ¶
type AccountPreferences struct { /* allowed instance types in the account (empty list for no restriction) */ AllowedInstanceTypes []string `json:"allowedInstanceTypes,omitempty"` /* lifecycle of the cluster in hours (0 for immortal clusters) Required: true Minimum: 0 */ ClusterTimeToLive int64 `json:"clusterTimeToLive"` /* max number of clusters in the account (0 when unlimited) Required: true Minimum: 0 */ MaxNumberOfClusters int64 `json:"maxNumberOfClusters"` /* max number of clusters for user within the account (0 when unlimited) Required: true Minimum: 0 */ MaxNumberOfClustersPerUser int64 `json:"maxNumberOfClustersPerUser"` /* max number of vms in a cluster of account (0 when unlimited) Required: true Minimum: 0 */ MaxNumberOfNodesPerCluster int64 `json:"maxNumberOfNodesPerCluster"` /* list of the cloudplatforms visible on the UI */ Platforms *string `json:"platforms,omitempty"` /* lifecycle of the account and its clusters in hours (0 for immortal account) Required: true Minimum: 0 */ UserTimeToLive int64 `json:"userTimeToLive"` }
AccountPreferences account preferences
swagger:model AccountPreferences
type AmbariAddress ¶
type AmbariAddress struct { /* ambari address Required: true */ AmbariAddress string `json:"ambariAddress"` }
AmbariAddress ambari address
swagger:model AmbariAddress
type AmbariDatabaseDetails ¶
type AmbariDatabaseDetails struct { /* host of the Ambari database Required: true Pattern: ^[a-zA-Z0-9]([a-zA-Z0-9-\.]+)$ */ Host string `json:"host"` /* name of the Ambari database Required: true Pattern: ^[^']+$ */ Name string `json:"name"` /* password for the Ambari database Required: true Pattern: ^[^']+$ */ Password string `json:"password"` /* port of the Ambari database Required: true */ Port int32 `json:"port"` /* user name for the Ambari database Required: true Pattern: ^[^']+$ */ UserName string `json:"userName"` /* vendor of the Ambari database Required: true */ Vendor string `json:"vendor"` }
AmbariDatabaseDetails ambari database details
swagger:model AmbariDatabaseDetails
type AmbariDatabaseTestResult ¶
type AmbariDatabaseTestResult struct { /* error Required: true */ Error string `json:"error"` }
AmbariDatabaseTestResult ambari database test result
swagger:model AmbariDatabaseTestResult
type AmbariRepoDetailsJSON ¶
type AmbariRepoDetailsJSON struct { /* url of the Ambari repository Required: true */ BaseURL string `json:"baseUrl"` /* gpg key of the Ambari repository Required: true */ GpgKeyURL string `json:"gpgKeyUrl"` /* version of the Ambari Required: true */ Version string `json:"version"` }
AmbariRepoDetailsJSON ambari repo details json
swagger:model AmbariRepoDetailsJson
type AmbariStackDetails ¶
type AmbariStackDetails struct { /* operating system for the stack, like redhat6 Required: true */ Os string `json:"os"` /* name of the stack, like HDP Required: true */ Stack string `json:"stack"` /* url of the stack repository Required: true */ StackBaseURL string `json:"stackBaseURL"` /* id of the stack repository Required: true */ StackRepoID string `json:"stackRepoId"` /* url of the stack utils repository Required: true */ UtilsBaseURL string `json:"utilsBaseURL"` /* id of the stack utils repository Required: true */ UtilsRepoID string `json:"utilsRepoId"` /* whether to verify or not the repo url Required: true */ Verify bool `json:"verify"` /* version of the stack Required: true */ Version string `json:"version"` }
AmbariStackDetails ambari stack details
swagger:model AmbariStackDetails
type BlueprintRequest ¶
type BlueprintRequest struct { /* ambari blueprint JSON, set this or the url field Required: true */ AmbariBlueprint string `json:"ambariBlueprint"` /* description of the resource Max Length: 1000 Min Length: 0 */ Description *string `json:"description,omitempty"` /* name of the resource Required: true Max Length: 100 Min Length: 1 */ Name string `json:"name"` /* url source of an ambari blueprint, set this or the ambariBlueprint field */ URL *string `json:"url,omitempty"` }
BlueprintRequest blueprint request
swagger:model BlueprintRequest
type BlueprintResponse ¶
type BlueprintResponse struct { /* gathered from blueprintName field from the blueprint JSON */ BlueprintName *string `json:"blueprintName,omitempty"` /* description of the resource Max Length: 1000 Min Length: 0 */ Description *string `json:"description,omitempty"` /* number of host groups */ HostGroupCount *int32 `json:"hostGroupCount,omitempty"` /* id of the resource */ ID *string `json:"id,omitempty"` /* name of the resource Required: true Max Length: 100 Min Length: 1 */ Name string `json:"name"` /* resource is visible in account */ Public *bool `json:"public,omitempty"` /* status of the blueprint */ Status *string `json:"status,omitempty"` }
BlueprintResponse blueprint response
swagger:model BlueprintResponse
type CertificateResponse ¶
type CertificateResponse struct { /* certificate used by the gateway */ Certificate []strfmt.Base64 `json:"certificate,omitempty"` }
CertificateResponse certificate response
swagger:model CertificateResponse
type CloudbreakDetailsJSON ¶
type CloudbreakDetailsJSON struct { /* version of the Cloudbreak that provisioned the stack */ Version *string `json:"version,omitempty"` }
CloudbreakDetailsJSON cloudbreak details json
swagger:model CloudbreakDetailsJson
type CloudbreakEvent ¶
type CloudbreakEvent struct { /* account id of the resource owner that is provided by OAuth provider */ Account *string `json:"account,omitempty"` /* availability zone of the stack */ AvailabilityZone *string `json:"availabilityZone,omitempty"` /* id of the referenced blueprint */ BlueprintID *int64 `json:"blueprintId,omitempty"` /* gathered from blueprintName field from the blueprint JSON */ BlueprintName *string `json:"blueprintName,omitempty"` /* type of cloud provider */ Cloud *string `json:"cloud,omitempty"` /* id of the cluster */ ClusterID *int64 `json:"clusterId,omitempty"` /* name of the cluster */ ClusterName *string `json:"clusterName,omitempty"` /* status of the cluster */ ClusterStatus *string `json:"clusterStatus,omitempty"` /* message of the event */ EventMessage *string `json:"eventMessage,omitempty"` /* timestamp of the event */ EventTimestamp *int64 `json:"eventTimestamp,omitempty"` /* type of the event */ EventType *string `json:"eventType,omitempty"` /* name of the instance group */ InstanceGroup *string `json:"instanceGroup,omitempty"` /* number of nodes */ NodeCount *int32 `json:"nodeCount,omitempty"` /* id of the resource owner that is provided by OAuth provider */ Owner *string `json:"owner,omitempty"` /* region of the stack */ Region *string `json:"region,omitempty"` /* id of the stack */ StackID *int64 `json:"stackId,omitempty"` /* name of the stack */ StackName *string `json:"stackName,omitempty"` /* status of the stack */ StackStatus *string `json:"stackStatus,omitempty"` }
CloudbreakEvent cloudbreak event
swagger:model CloudbreakEvent
type CloudbreakUsage ¶
type CloudbreakUsage struct { /* account id of the resource owner that is provided by OAuth provider */ Account *string `json:"account,omitempty"` /* availability zone of the stack */ AvailabilityZone *string `json:"availabilityZone,omitempty"` /* id of the blueprint */ BlueprintID *int64 `json:"blueprintId,omitempty"` /* name of the blueprint */ BlueprintName *string `json:"blueprintName,omitempty"` /* computed costs of instance usage */ Costs *float64 `json:"costs,omitempty"` /* days since the instance is running */ Day *string `json:"day,omitempty"` /* group name of instance */ InstanceGroup *string `json:"instanceGroup,omitempty"` /* hours since the instance is running */ InstanceHours *int64 `json:"instanceHours,omitempty"` /* type of instance */ InstanceType *string `json:"instanceType,omitempty"` /* id of the resource owner that is provided by OAuth provider */ Owner *string `json:"owner,omitempty"` /* cloud provider of the stack */ Provider *string `json:"provider,omitempty"` /* region of the stack */ Region *string `json:"region,omitempty"` /* id of the stack */ StackID *int64 `json:"stackId,omitempty"` /* name of the stack */ StackName *string `json:"stackName,omitempty"` /* ambari username */ Username *string `json:"username,omitempty"` }
CloudbreakUsage cloudbreak usage
swagger:model CloudbreakUsage
type ClusterRequest ¶
type ClusterRequest struct { /* ambari database details */ AmbariDatabaseDetails *AmbariDatabaseDetails `json:"ambariDatabaseDetails,omitempty"` /* ambari repo details json */ AmbariRepoDetailsJSON *AmbariRepoDetailsJSON `json:"ambariRepoDetailsJson,omitempty"` /* ambari stack details */ AmbariStackDetails *AmbariStackDetails `json:"ambariStackDetails,omitempty"` /* blueprint id for the cluster Required: true */ BlueprintID int64 `json:"blueprintId"` /* config recommendation strategy */ ConfigStrategy *string `json:"configStrategy,omitempty"` /* description of the resource Max Length: 1000 Min Length: 0 */ Description *string `json:"description,omitempty"` /* send email about the result of the cluster installation */ EmailNeeded *bool `json:"emailNeeded,omitempty"` /* send email to the requested address */ EmailTo *string `json:"emailTo,omitempty"` /* enable security */ EnableSecurity *bool `json:"enableSecurity,omitempty"` /* shipyard service enabled in the cluster */ EnableShipyard *bool `json:"enableShipyard,omitempty"` /* file system */ FileSystem *FileSystem `json:"fileSystem,omitempty"` /* host groups Required: true Unique: true */ HostGroups []*HostGroup `json:"hostGroups"` /* kerberos admin Max Length: 15 Min Length: 5 */ KerberosAdmin string `json:"kerberosAdmin,omitempty"` /* kerberos master key Max Length: 50 Min Length: 3 */ KerberosMasterKey string `json:"kerberosMasterKey,omitempty"` /* kerberos password Max Length: 50 Min Length: 5 */ KerberosPassword string `json:"kerberosPassword,omitempty"` /* LDAP config id for the cluster */ LdapConfigID *int64 `json:"ldapConfigId,omitempty"` /* flag for default LDAP support */ LdapRequired *bool `json:"ldapRequired,omitempty"` /* name of the resource Required: true Max Length: 40 Min Length: 5 Pattern: ([a-z][-a-z0-9]*[a-z0-9]) */ Name string `json:"name"` /* ambari password Required: true Max Length: 100 Min Length: 5 */ Password string `json:"password"` /* RDS configuration id for the cluster */ RdsConfigID *int64 `json:"rdsConfigId,omitempty"` /* rds config json */ RdsConfigJSON *RDSConfig `json:"rdsConfigJson,omitempty"` /* SSSD config id for the cluster */ SssdConfigID *int64 `json:"sssdConfigId,omitempty"` /* ambari username Required: true Max Length: 15 Min Length: 5 Pattern: ([a-z][-a-z0-9]*[a-z0-9]) */ UserName string `json:"userName"` /* validate blueprint */ ValidateBlueprint *bool `json:"validateBlueprint,omitempty"` }
ClusterRequest cluster request
swagger:model ClusterRequest
type ClusterResponse ¶
type ClusterResponse struct { /* public ambari ip of the stack */ AmbariServerIP *string `json:"ambariServerIp,omitempty"` /* ambari stack details */ AmbariStackDetails *AmbariStackDetails `json:"ambariStackDetails,omitempty"` /* Additional information for ambari cluster */ Attributes map[string]interface{} `json:"attributes,omitempty"` /* blueprint id for the cluster */ BlueprintID *int64 `json:"blueprintId,omitempty"` /* name of the cluster */ Cluster *string `json:"cluster,omitempty"` /* config recommendation strategy */ ConfigStrategy *string `json:"configStrategy,omitempty"` /* description of the resource */ Description *string `json:"description,omitempty"` /* shipyard service enabled in the cluster */ EnableShipyard *bool `json:"enableShipyard,omitempty"` /* host groups Unique: true */ HostGroups []*HostGroup `json:"hostGroups,omitempty"` /* duration - how long the cluster is running in hours */ HoursUp *int32 `json:"hoursUp,omitempty"` /* id of the resource */ ID *int64 `json:"id,omitempty"` /* LDAP config id for the cluster */ LdapConfigID *int64 `json:"ldapConfigId,omitempty"` /* flag for default LDAP support */ LdapRequired *bool `json:"ldapRequired,omitempty"` /* duration - how long the cluster is running in minutes (minus hours) */ MinutesUp *int32 `json:"minutesUp,omitempty"` /* name of the resource */ Name *string `json:"name,omitempty"` /* ambari password Required: true */ Password string `json:"password"` /* RDS configuration id for the cluster */ RdsConfigID *int64 `json:"rdsConfigId,omitempty"` /* secure */ Secure *bool `json:"secure,omitempty"` /* most important services in the cluster */ ServiceEndPoints map[string]string `json:"serviceEndPoints,omitempty"` /* SSSD config id for the cluster */ SssdConfigID *int64 `json:"sssdConfigId,omitempty"` /* status of the cluster */ Status *string `json:"status,omitempty"` /* status message of the cluster */ StatusReason *string `json:"statusReason,omitempty"` /* ambari username Required: true */ UserName string `json:"userName"` }
ClusterResponse cluster response
swagger:model ClusterResponse
type Constraint ¶
type Constraint struct { /* name of a constraint template that defines the resource constraints for the hostgroup */ ConstraintTemplateName *string `json:"constraintTemplateName,omitempty"` /* host count Required: true */ HostCount int32 `json:"hostCount"` /* name of an instance group where the hostgroup will be deployed */ InstanceGroupName *string `json:"instanceGroupName,omitempty"` }
Constraint constraint
swagger:model Constraint
type ConstraintTemplateRequest ¶
type ConstraintTemplateRequest struct { /* number of CPU cores needed for the Ambari node Required: true Read Only: true */ CPU float64 `json:"cpu"` /* description of the resource Max Length: 1000 Min Length: 0 */ Description *string `json:"description,omitempty"` /* disk size needed for an Ambari node (GB) Required: true Read Only: true */ Disk float64 `json:"disk"` /* memory needed for the Ambari container (GB) Required: true Read Only: true */ Memory float64 `json:"memory"` /* name of the resource Required: true Max Length: 100 Min Length: 5 Pattern: ([a-z][-a-z0-9]*[a-z0-9]) */ Name string `json:"name"` /* type of orchestrator Required: true Read Only: true */ OrchestratorType string `json:"orchestratorType"` }
ConstraintTemplateRequest constraint template request
swagger:model ConstraintTemplateRequest
type ConstraintTemplateResponse ¶
type ConstraintTemplateResponse struct { /* number of CPU cores needed for the Ambari node Required: true Read Only: true */ CPU float64 `json:"cpu"` /* description of the resource Max Length: 1000 Min Length: 0 */ Description *string `json:"description,omitempty"` /* disk size needed for an Ambari node (GB) Required: true Read Only: true */ Disk float64 `json:"disk"` /* id of the resource */ ID *int64 `json:"id,omitempty"` /* memory needed for the Ambari container (GB) Required: true Read Only: true */ Memory float64 `json:"memory"` /* name of the resource Required: true Max Length: 100 Min Length: 5 Pattern: ([a-z][-a-z0-9]*[a-z0-9]) */ Name string `json:"name"` /* type of orchestrator Required: true Read Only: true */ OrchestratorType string `json:"orchestratorType"` /* resource is visible in account Required: true Read Only: true */ PublicInAccount bool `json:"publicInAccount"` }
ConstraintTemplateResponse constraint template response
swagger:model ConstraintTemplateResponse
type CredentialRequest ¶
type CredentialRequest struct { /* type of cloud provider Required: true */ CloudPlatform string `json:"cloudPlatform"` /* description of the resource Max Length: 1000 Min Length: 0 */ Description *string `json:"description,omitempty"` /* authentication name for machines */ LoginUserName *string `json:"loginUserName,omitempty"` /* name of the resource Required: true Max Length: 100 Min Length: 5 Pattern: ([a-z][-a-z0-9]*[a-z0-9]) */ Name string `json:"name"` /* cloud specific parameters for credential Required: true */ Parameters map[string]interface{} `json:"parameters"` /* public key for accessing instances Required: true */ PublicKey string `json:"publicKey"` /* id of the topology the resource belongs to */ TopologyID *int64 `json:"topologyId,omitempty"` }
CredentialRequest credential request
swagger:model CredentialRequest
type CredentialResponse ¶
type CredentialResponse struct { /* type of cloud provider Required: true */ CloudPlatform string `json:"cloudPlatform"` /* description of the resource Max Length: 1000 Min Length: 0 */ Description *string `json:"description,omitempty"` /* id of the resource */ ID *int64 `json:"id,omitempty"` /* authentication name for machines */ LoginUserName *string `json:"loginUserName,omitempty"` /* name of the resource Required: true Max Length: 100 Min Length: 5 Pattern: ([a-z][-a-z0-9]*[a-z0-9]) */ Name string `json:"name"` /* cloud specific parameters for credential Required: true */ Parameters map[string]interface{} `json:"parameters"` /* resource is visible in account */ Public *bool `json:"public,omitempty"` /* public key for accessing instances Required: true */ PublicKey string `json:"publicKey"` /* id of the topology the resource belongs to */ TopologyID *int64 `json:"topologyId,omitempty"` }
CredentialResponse credential response
swagger:model CredentialResponse
type FailurePolicy ¶
type FailurePolicy struct { /* adjustment type Required: true */ AdjustmentType string `json:"adjustmentType"` /* id of the resource */ ID *int64 `json:"id,omitempty"` /* threshold of failure policy */ Threshold *int64 `json:"threshold,omitempty"` }
FailurePolicy failure policy
swagger:model FailurePolicy
type FileSystem ¶
type FileSystem struct { /* true if fs.defaultFS should point to this filesystem Required: true */ DefaultFs bool `json:"defaultFs"` /* name of the filesystem Required: true */ Name string `json:"name"` /* configuration of the filesystem access as key-value pairs Required: true */ Properties map[string]string `json:"properties"` /* type of the filesystem Required: true */ Type string `json:"type"` }
FileSystem file system
swagger:model FileSystem
type HostGroup ¶
type HostGroup struct { /* instance group or resource constraint for a hostgroup Required: true */ Constraint *Constraint `json:"constraint"` /* metadata Unique: true */ Metadata []*HostMetadata `json:"metadata,omitempty"` /* name of the resource Required: true */ Name string `json:"name"` /* referenced recipe ids Unique: true */ RecipeIds []int64 `json:"recipeIds,omitempty"` }
HostGroup host group
swagger:model HostGroup
type HostGroupAdjustment ¶
type HostGroupAdjustment struct { /* name of the host group Required: true */ HostGroup string `json:"hostGroup"` /* scaling adjustment of the host groups Required: true */ ScalingAdjustment int32 `json:"scalingAdjustment"` /* on cluster update, update stack too */ WithStackUpdate *bool `json:"withStackUpdate,omitempty"` }
HostGroupAdjustment host group adjustment
swagger:model HostGroupAdjustment
type HostMetadata ¶
type HostMetadata struct { /* name of the host group */ GroupName *string `json:"groupName,omitempty"` /* id of the resource */ ID *int64 `json:"id,omitempty"` /* name of the resource */ Name *string `json:"name,omitempty"` /* state of the host */ State *string `json:"state,omitempty"` }
HostMetadata host metadata
swagger:model HostMetadata
type ImageJSON ¶
type ImageJSON struct { /* name of the image */ ImageName *string `json:"imageName,omitempty"` }
ImageJSON image json
swagger:model ImageJson
type InstanceGroup ¶
type InstanceGroup struct { /* name of the instance group Required: true */ Group string `json:"group"` /* id of the resource Read Only: true */ ID *int64 `json:"id,omitempty"` /* metadata Read Only: true Unique: true */ Metadata []*InstanceMetaData `json:"metadata,omitempty"` /* number of nodes Required: true Maximum: 100000 Minimum: 1 */ NodeCount int32 `json:"nodeCount"` /* security group resource id for the instance group Required: true */ SecurityGroupID int64 `json:"securityGroupId"` /* referenced template id Required: true */ TemplateID int64 `json:"templateId"` /* type of the instance group */ Type *string `json:"type,omitempty"` }
InstanceGroup instance group
swagger:model InstanceGroup
type InstanceGroupAdjustment ¶
type InstanceGroupAdjustment struct { /* name of the instance group Required: true */ InstanceGroup string `json:"instanceGroup"` /* scaling adjustment of the instance groups Required: true */ ScalingAdjustment int32 `json:"scalingAdjustment"` /* on stack update, update cluster too */ WithClusterEvent *bool `json:"withClusterEvent,omitempty"` }
InstanceGroupAdjustment instance group adjustment
swagger:model InstanceGroupAdjustment
type InstanceMetaData ¶
type InstanceMetaData struct { /* ambari server address */ AmbariServer *bool `json:"ambariServer,omitempty"` /* the fully qualified domain name of the node in the service discovery cluster */ DiscoveryFQDN *string `json:"discoveryFQDN,omitempty"` /* name of the instance group */ InstanceGroup *string `json:"instanceGroup,omitempty"` /* id of the instance */ InstanceID *string `json:"instanceId,omitempty"` /* status of the instance */ InstanceStatus *string `json:"instanceStatus,omitempty"` /* private ip of the insctance */ PrivateIP *string `json:"privateIp,omitempty"` /* public ip of the instance */ PublicIP *string `json:"publicIp,omitempty"` /* ssh port */ SSHPort *int32 `json:"sshPort,omitempty"` }
InstanceMetaData instance meta data
swagger:model InstanceMetaData
type LdapConfigRequest ¶
type LdapConfigRequest struct { /* bind distinguished name for connection test and group search (e.g. cn=admin,dc=example,dc=org) */ BindDn *string `json:"bindDn,omitempty"` /* password for the provided bind DN */ BindPassword *string `json:"bindPassword,omitempty"` /* description of the resource Max Length: 1000 Min Length: 0 */ Description *string `json:"description,omitempty"` /* template for group search for authorization (e.g. dc=hadoop,dc=apache,dc=org) */ GroupSearchBase *string `json:"groupSearchBase,omitempty"` /* filter for group search for authorization */ GroupSearchFilter *string `json:"groupSearchFilter,omitempty"` /* name of the resource Required: true Max Length: 100 Min Length: 1 */ Name string `json:"name"` /* parses the principal for insertion into templates via regex. */ PrincipalRegex *string `json:"principalRegex,omitempty"` /* public host or IP address of LDAP server Required: true */ ServerHost string `json:"serverHost"` /* port of LDAP server (typically: 389 or 636 for LDAPS) Required: true Maximum: 65535 Minimum: 1 */ ServerPort int32 `json:"serverPort"` /* determines if LDAP or LDAP over SSL is to be used Required: true */ ServerSSL bool `json:"serverSSL"` /* template for user search for authentication (e.g. dc=hadoop,dc=apache,dc=org) Required: true */ UserSearchBase string `json:"userSearchBase"` /* filter for user search for authentication (e.g. (&(objectclass=person)(sAMAccountName={2})) ) */ UserSearchFilter *string `json:"userSearchFilter,omitempty"` }
LdapConfigRequest ldap config request
swagger:model LdapConfigRequest
type LdapConfigResponse ¶
type LdapConfigResponse struct { /* bind distinguished name for connection test and group search (e.g. cn=admin,dc=example,dc=org) */ BindDn *string `json:"bindDn,omitempty"` /* password for the provided bind DN */ BindPassword *string `json:"bindPassword,omitempty"` /* description of the resource Max Length: 1000 Min Length: 0 */ Description *string `json:"description,omitempty"` /* template for group search for authorization (e.g. dc=hadoop,dc=apache,dc=org) */ GroupSearchBase *string `json:"groupSearchBase,omitempty"` /* filter for group search for authorization */ GroupSearchFilter *string `json:"groupSearchFilter,omitempty"` /* id of the resource */ ID *int64 `json:"id,omitempty"` /* name of the resource Required: true Max Length: 100 Min Length: 1 */ Name string `json:"name"` /* parses the principal for insertion into templates via regex. */ PrincipalRegex *string `json:"principalRegex,omitempty"` /* resource is visible in account */ Public *bool `json:"public,omitempty"` /* public host or IP address of LDAP server Required: true */ ServerHost string `json:"serverHost"` /* port of LDAP server (typically: 389 or 636 for LDAPS) Required: true Maximum: 65535 Minimum: 1 */ ServerPort int32 `json:"serverPort"` /* determines if LDAP or LDAP over SSL is to be used Required: true */ ServerSSL bool `json:"serverSSL"` /* template for user search for authentication (e.g. dc=hadoop,dc=apache,dc=org) Required: true */ UserSearchBase string `json:"userSearchBase"` /* filter for user search for authentication (e.g. (&(objectclass=person)(sAMAccountName={2})) ) */ UserSearchFilter *string `json:"userSearchFilter,omitempty"` }
LdapConfigResponse ldap config response
swagger:model LdapConfigResponse
type NetworkJSON ¶
type NetworkJSON struct { /* type of cloud provider Required: true */ CloudPlatform string `json:"cloudPlatform"` /* description of the resource Max Length: 1000 Min Length: 0 */ Description *string `json:"description,omitempty"` /* id of the resource Read Only: true */ ID *int64 `json:"id,omitempty"` /* name of the resource Required: true Max Length: 100 Min Length: 1 Pattern: ([a-z][-a-z0-9]*[a-z0-9]) */ Name string `json:"name"` /* provider specific parameters of the specified network Required: true */ Parameters map[string]interface{} `json:"parameters"` /* resource is visible in account Required: true Read Only: true */ PublicInAccount bool `json:"publicInAccount"` /* the subnet definition of the network in CIDR format */ SubnetCIDR *string `json:"subnetCIDR,omitempty"` /* id of the topology the resource belongs to */ TopologyID *int64 `json:"topologyId,omitempty"` }
NetworkJSON network json
swagger:model NetworkJson
type OrchestratorRequest ¶
type OrchestratorRequest struct { /* endpoint for the container orchestration api */ APIEndpoint *string `json:"apiEndpoint,omitempty"` /* orchestrator specific parameters, like authentication details */ Parameters map[string]interface{} `json:"parameters,omitempty"` /* type of the orchestrator (Swarm or Marathon) Required: true */ Type string `json:"type"` }
OrchestratorRequest orchestrator request
swagger:model OrchestratorRequest
type OrchestratorResponse ¶
type OrchestratorResponse struct { /* endpoint for the container orchestration api */ APIEndpoint *string `json:"apiEndpoint,omitempty"` /* orchestrator specific parameters, like authentication details */ Parameters map[string]interface{} `json:"parameters,omitempty"` /* type of the orchestrator (Swarm or Marathon) Required: true */ Type string `json:"type"` }
OrchestratorResponse orchestrator response
swagger:model OrchestratorResponse
type PlatformVariantsJSON ¶
type PlatformVariantsJSON struct { /* default variants */ DefaultVariants map[string]string `json:"defaultVariants,omitempty"` /* platform to variants */ PlatformToVariants map[string][]string `json:"platformToVariants,omitempty"` }
PlatformVariantsJSON platform variants json
swagger:model PlatformVariantsJson
type RDSConfig ¶
type RDSConfig struct { /* Password to use for the jdbc connection Required: true */ ConnectionPassword string `json:"connectionPassword"` /* JDBC connection URL in the form of jdbc:<db-type>://<address>:<port>/<db> Required: true */ ConnectionURL string `json:"connectionURL"` /* Username to use for the jdbc connection Required: true */ ConnectionUserName string `json:"connectionUserName"` /* Type of the external database (allowed values: MYSQL, POSTGRES) Required: true */ DatabaseType string `json:"databaseType"` /* HDP version for the RDS configuration Required: true */ HdpVersion string `json:"hdpVersion"` /* Name of the RDS configuration resource Required: true */ Name string `json:"name"` /* If true, then the RDS configuration will be validated */ Validated *bool `json:"validated,omitempty"` }
RDSConfig r d s config
swagger:model RDSConfig
type RDSConfigResponse ¶
type RDSConfigResponse struct { /* cluster names Unique: true */ ClusterNames []string `json:"clusterNames,omitempty"` /* Password to use for the jdbc connection Required: true */ ConnectionPassword string `json:"connectionPassword"` /* JDBC connection URL in the form of jdbc:<db-type>://<address>:<port>/<db> Required: true */ ConnectionURL string `json:"connectionURL"` /* Username to use for the jdbc connection Required: true */ ConnectionUserName string `json:"connectionUserName"` /* creation date */ CreationDate *int64 `json:"creationDate,omitempty"` /* Type of the external database (allowed values: MYSQL, POSTGRES) Required: true */ DatabaseType string `json:"databaseType"` /* HDP version for the RDS configuration Required: true */ HdpVersion string `json:"hdpVersion"` /* id of the resource */ ID *string `json:"id,omitempty"` /* Name of the RDS configuration resource Required: true */ Name string `json:"name"` /* resource is visible in account */ PublicInAccount *bool `json:"publicInAccount,omitempty"` /* If true, then the RDS configuration will be validated */ Validated *bool `json:"validated,omitempty"` }
RDSConfigResponse r d s config response
swagger:model RDSConfigResponse
type RdsTestResult ¶
type RdsTestResult struct { /* connection result Required: true */ ConnectionResult string `json:"connectionResult"` }
RdsTestResult rds test result
swagger:model RdsTestResult
type RecipeRequest ¶
type RecipeRequest struct { /* description of the resource Max Length: 1000 Min Length: 0 */ Description *string `json:"description,omitempty"` /* name of the resource Required: true Max Length: 100 Min Length: 1 Pattern: ([a-z][-a-z0-9]*[a-z0-9]) */ Name string `json:"name"` /* list of consul plugins with execution types Required: true Unique: true */ Plugins []string `json:"plugins"` /* additional plugin properties */ Properties map[string]string `json:"properties,omitempty"` /* recipe timeout in minutes */ Timeout *int32 `json:"timeout,omitempty"` }
RecipeRequest recipe request
swagger:model RecipeRequest
type RecipeResponse ¶
type RecipeResponse struct { /* description of the resource Max Length: 1000 Min Length: 0 */ Description *string `json:"description,omitempty"` /* id of the resource */ ID *int64 `json:"id,omitempty"` /* name of the resource Required: true Max Length: 100 Min Length: 1 Pattern: ([a-z][-a-z0-9]*[a-z0-9]) */ Name string `json:"name"` /* list of consul plugins with execution types Required: true Unique: true */ Plugins []string `json:"plugins"` /* additional plugin properties */ Properties map[string]string `json:"properties,omitempty"` /* resource is visible in account */ Public *bool `json:"public,omitempty"` /* recipe timeout in minutes */ Timeout *int32 `json:"timeout,omitempty"` }
RecipeResponse recipe response
swagger:model RecipeResponse
type SecurityGroupJSON ¶
type SecurityGroupJSON struct { /* account id of the resource owner that is provided by OAuth provider */ Account *string `json:"account,omitempty"` /* description of the resource Max Length: 1000 Min Length: 0 */ Description *string `json:"description,omitempty"` /* id of the resource */ ID *int64 `json:"id,omitempty"` /* name of the resource Required: true Max Length: 100 Min Length: 1 Pattern: ([a-z][-a-z0-9]*[a-z0-9]) */ Name string `json:"name"` /* id of the resource owner that is provided by OAuth provider */ Owner *string `json:"owner,omitempty"` /* resource is visible in account Required: true */ PublicInAccount bool `json:"publicInAccount"` /* list of security rules that relates to the security group Required: true */ SecurityRules []*SecurityRule `json:"securityRules"` }
SecurityGroupJSON security group json
swagger:model SecurityGroupJson
type SecurityRule ¶
type SecurityRule struct { /* id of the resource */ ID *int64 `json:"id,omitempty"` /* flag for making the rule modifiable */ Modifiable *bool `json:"modifiable,omitempty"` /* comma separated list of accessible ports Required: true Pattern: ^[0-9]+(,[0-9]+)*$ */ Ports string `json:"ports"` /* protocol of the rule Required: true */ Protocol string `json:"protocol"` /* definition of allowed subnet in CIDR format Required: true Pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$ */ Subnet string `json:"subnet"` }
SecurityRule security rule
swagger:model SecurityRule
type SssdConfigRequest ¶
type SssdConfigRequest struct { /* comma-separated list of IP addresses or hostnames of the AD servers Max Length: 255 Min Length: 0 */ AdServer *string `json:"adServer,omitempty"` /* search base of the database Required: true Max Length: 255 Min Length: 10 */ BaseSearch string `json:"baseSearch"` /* custom configuration */ Configuration *string `json:"configuration,omitempty"` /* description of the resource Max Length: 1000 Min Length: 0 */ Description *string `json:"description,omitempty"` /* name of the Kerberos realm Max Length: 255 Min Length: 0 */ KerberosRealm *string `json:"kerberosRealm,omitempty"` /* comma-separated list of IP addresses or hostnames of the Kerberos servers Max Length: 255 Min Length: 0 */ KerberosServer *string `json:"kerberosServer,omitempty"` /* name of the resource Required: true Max Length: 100 Min Length: 1 Pattern: ([a-z][-a-z0-9]*[a-z0-9]) */ Name string `json:"name"` /* provider type Required: true */ ProviderType string `json:"providerType"` /* schema of the database Required: true */ Schema string `json:"schema"` /* TLS behavior of the connection Required: true */ TLSReqcert string `json:"tlsReqcert"` /* comma-separated list of URIs of the LDAP servers Required: true Max Length: 255 Min Length: 10 */ URL string `json:"url"` }
SssdConfigRequest sssd config request
swagger:model SssdConfigRequest
type SssdConfigResponse ¶
type SssdConfigResponse struct { /* comma-separated list of IP addresses or hostnames of the AD servers Max Length: 255 Min Length: 0 */ AdServer *string `json:"adServer,omitempty"` /* search base of the database Required: true Max Length: 255 Min Length: 10 */ BaseSearch string `json:"baseSearch"` /* custom configuration */ Configuration *string `json:"configuration,omitempty"` /* description of the resource Max Length: 1000 Min Length: 0 */ Description *string `json:"description,omitempty"` /* id of the resource */ ID *int64 `json:"id,omitempty"` /* name of the Kerberos realm Max Length: 255 Min Length: 0 */ KerberosRealm *string `json:"kerberosRealm,omitempty"` /* comma-separated list of IP addresses or hostnames of the Kerberos servers Max Length: 255 Min Length: 0 */ KerberosServer *string `json:"kerberosServer,omitempty"` /* name of the resource Required: true Max Length: 100 Min Length: 1 Pattern: ([a-z][-a-z0-9]*[a-z0-9]) */ Name string `json:"name"` /* provider type Required: true */ ProviderType string `json:"providerType"` /* resource is visible in account */ Public *bool `json:"public,omitempty"` /* schema of the database Required: true */ Schema string `json:"schema"` /* TLS behavior of the connection Required: true */ TLSReqcert string `json:"tlsReqcert"` /* comma-separated list of URIs of the LDAP servers Required: true Max Length: 255 Min Length: 10 */ URL string `json:"url"` }
SssdConfigResponse sssd config response
swagger:model SssdConfigResponse
type StackRequest ¶
type StackRequest struct { /* specific version of ambari */ AmbariVersion *string `json:"ambariVersion,omitempty"` /* availability zone of the stack */ AvailabilityZone *string `json:"availabilityZone,omitempty"` /* type of cloud provider Required: true Read Only: true */ CloudPlatform string `json:"cloudPlatform"` /* credential resource id for the stack Required: true */ CredentialID int64 `json:"credentialId"` /* failure policy in case of failures */ FailurePolicy *FailurePolicy `json:"failurePolicy,omitempty"` /* specific version of HDP */ HdpVersion *string `json:"hdpVersion,omitempty"` /* custom image catalog URL */ ImageCatalog *string `json:"imageCatalog,omitempty"` /* instance groups Required: true */ InstanceGroups []*InstanceGroup `json:"instanceGroups"` /* name of the stack Required: true Max Length: 40 Min Length: 5 Pattern: ([a-z][-a-z0-9]*[a-z0-9]) */ Name string `json:"name"` /* network resource id for the stack Required: true */ NetworkID int64 `json:"networkId"` /* action on failure */ OnFailureAction *string `json:"onFailureAction,omitempty"` /* the details of the container orchestrator api to use */ Orchestrator *OrchestratorRequest `json:"orchestrator,omitempty"` /* additional cloud specific parameters for stack */ Parameters map[string]string `json:"parameters,omitempty"` /* cloud provider api variant */ PlatformVariant *string `json:"platformVariant,omitempty"` /* region of the stack Required: true */ Region string `json:"region"` /* relocate the docker service in startup time */ RelocateDocker *bool `json:"relocateDocker,omitempty"` }
StackRequest stack request
swagger:model StackRequest
type StackResponse ¶
type StackResponse struct { /* account id of the resource owner that is provided by OAuth provider */ Account *string `json:"account,omitempty"` /* specific version of ambari */ AmbariVersion *string `json:"ambariVersion,omitempty"` /* availability zone of the stack */ AvailabilityZone *string `json:"availabilityZone,omitempty"` /* type of cloud provider Required: true Read Only: true */ CloudPlatform string `json:"cloudPlatform"` /* details of the Cloudbreak that provisioned the stack */ CloudbreakDetails *CloudbreakDetailsJSON `json:"cloudbreakDetails,omitempty"` /* cluster */ Cluster *ClusterResponse `json:"cluster,omitempty"` /* creation time of the stack in long */ Created *int64 `json:"created,omitempty"` /* credential resource id for the stack Required: true */ CredentialID int64 `json:"credentialId"` /* failure policy in case of failures */ FailurePolicy *FailurePolicy `json:"failurePolicy,omitempty"` /* port of the gateway secured proxy */ GatewayPort *int32 `json:"gatewayPort,omitempty"` /* specific version of HDP */ HdpVersion *string `json:"hdpVersion,omitempty"` /* id of the stack */ ID *int64 `json:"id,omitempty"` /* image of the stack */ Image *ImageJSON `json:"image,omitempty"` /* instance groups */ InstanceGroups []*InstanceGroup `json:"instanceGroups,omitempty"` /* name of the stack Required: true Max Length: 40 Min Length: 5 Pattern: ([a-z][-a-z0-9]*[a-z0-9]) */ Name string `json:"name"` /* network resource id for the stack Required: true */ NetworkID int64 `json:"networkId"` /* action on failure */ OnFailureAction *string `json:"onFailureAction,omitempty"` /* the details of the container orchestrator api to use */ Orchestrator *OrchestratorResponse `json:"orchestrator,omitempty"` /* id of the resource owner that is provided by OAuth provider */ Owner *string `json:"owner,omitempty"` /* additional cloud specific parameters for stack */ Parameters map[string]string `json:"parameters,omitempty"` /* cloud provider api variant */ PlatformVariant *string `json:"platformVariant,omitempty"` /* resource is visible in account */ Public *bool `json:"public,omitempty"` /* region of the stack Required: true */ Region string `json:"region"` /* relocate the docker service in startup time */ RelocateDocker *bool `json:"relocateDocker,omitempty"` /* status of the stack */ Status *string `json:"status,omitempty"` /* status message of the stack */ StatusReason *string `json:"statusReason,omitempty"` }
StackResponse stack response
swagger:model StackResponse
type StackValidationRequest ¶
type StackValidationRequest struct { /* id of the referenced blueprint Required: true */ BlueprintID int64 `json:"blueprintId"` /* file system */ FileSystem *FileSystem `json:"fileSystem,omitempty"` /* host groups Required: true Unique: true */ HostGroups []*HostGroup `json:"hostGroups"` /* instance groups Required: true Unique: true */ InstanceGroups []*InstanceGroup `json:"instanceGroups"` /* network resource id for the stack Required: true */ NetworkID int64 `json:"networkId"` /* type of cloud provider Required: true */ Platform string `json:"platform"` }
StackValidationRequest stack validation request
swagger:model StackValidationRequest
type TemplateRequest ¶
type TemplateRequest struct { /* type of cloud provider Required: true */ CloudPlatform string `json:"cloudPlatform"` /* description of the resource Max Length: 1000 Min Length: 0 */ Description *string `json:"description,omitempty"` /* type of the instance Required: true */ InstanceType string `json:"instanceType"` /* name of the resource Required: true Max Length: 100 Min Length: 5 Pattern: ([a-z][-a-z0-9]*[a-z0-9]) */ Name string `json:"name"` /* cloud specific parameters for template Required: true */ Parameters map[string]interface{} `json:"parameters"` /* resource is visible in account Required: true Read Only: true */ Public bool `json:"public"` /* id of the topology the resource belongs to */ TopologyID *int64 `json:"topologyId,omitempty"` /* number of volumes Required: true */ VolumeCount int32 `json:"volumeCount"` /* size of volumes */ VolumeSize *int32 `json:"volumeSize,omitempty"` /* type of the volumes */ VolumeType *string `json:"volumeType,omitempty"` }
TemplateRequest template request
swagger:model TemplateRequest
type TemplateResponse ¶
type TemplateResponse struct { /* type of cloud provider Required: true */ CloudPlatform string `json:"cloudPlatform"` /* description of the resource Max Length: 1000 Min Length: 0 */ Description *string `json:"description,omitempty"` /* id of the resource */ ID *int64 `json:"id,omitempty"` /* type of the instance Required: true */ InstanceType string `json:"instanceType"` /* name of the resource Required: true Max Length: 100 Min Length: 5 Pattern: ([a-z][-a-z0-9]*[a-z0-9]) */ Name string `json:"name"` /* cloud specific parameters for template Required: true */ Parameters map[string]interface{} `json:"parameters"` /* resource is visible in account Required: true Read Only: true */ Public bool `json:"public"` /* id of the topology the resource belongs to */ TopologyID *int64 `json:"topologyId,omitempty"` /* number of volumes Required: true */ VolumeCount int32 `json:"volumeCount"` /* size of volumes */ VolumeSize *int32 `json:"volumeSize,omitempty"` /* type of the volumes */ VolumeType *string `json:"volumeType,omitempty"` }
TemplateResponse template response
swagger:model TemplateResponse
type TopologyRequest ¶
type TopologyRequest struct { /* cloud platform */ CloudPlatform *string `json:"cloudPlatform,omitempty"` /* description */ Description *string `json:"description,omitempty"` /* endpoint */ Endpoint *string `json:"endpoint,omitempty"` /* id */ ID *int64 `json:"id,omitempty"` /* name */ Name *string `json:"name,omitempty"` /* nodes */ Nodes map[string]string `json:"nodes,omitempty"` }
TopologyRequest topology request
swagger:model TopologyRequest
type TopologyResponse ¶
type TopologyResponse struct { /* cloud platform */ CloudPlatform *string `json:"cloudPlatform,omitempty"` /* description */ Description *string `json:"description,omitempty"` /* endpoint */ Endpoint *string `json:"endpoint,omitempty"` /* id */ ID *int64 `json:"id,omitempty"` /* name */ Name *string `json:"name,omitempty"` /* nodes */ Nodes map[string]string `json:"nodes,omitempty"` }
TopologyResponse topology response
swagger:model TopologyResponse
type UpdateCluster ¶
type UpdateCluster struct { /* ambari stack details */ AmbariStackDetails *AmbariStackDetails `json:"ambariStackDetails,omitempty"` /* id of the referenced blueprint */ BlueprintID *int64 `json:"blueprintId,omitempty"` /* host group adjustment Required: true */ HostGroupAdjustment *HostGroupAdjustment `json:"hostGroupAdjustment"` /* hostgroups Unique: true */ Hostgroups []*HostGroup `json:"hostgroups,omitempty"` /* status Required: true */ Status string `json:"status"` /* user name password json Required: true */ UserNamePasswordJSON *UserNamePasswordJSON `json:"userNamePasswordJson"` /* validate blueprint */ ValidateBlueprint *bool `json:"validateBlueprint,omitempty"` }
UpdateCluster update cluster
swagger:model UpdateCluster
type UpdateStack ¶
type UpdateStack struct { /* instance group adjustment */ InstanceGroupAdjustment *InstanceGroupAdjustment `json:"instanceGroupAdjustment,omitempty"` /* status Required: true */ Status string `json:"status"` }
UpdateStack update stack
swagger:model UpdateStack
type User ¶
type User struct { /* username */ Username *string `json:"username,omitempty"` }
User user
swagger:model User
type UserNamePasswordJSON ¶
type UserNamePasswordJSON struct { /* old password in ambari Required: true */ OldPassword string `json:"oldPassword"` /* new password in ambari Required: true */ Password string `json:"password"` /* new user name in ambari Required: true */ UserName string `json:"userName"` }
UserNamePasswordJSON user name password json
swagger:model UserNamePasswordJson
Source Files
¶
- account_preferences.go
- ambari_address.go
- ambari_database_details.go
- ambari_database_test_result.go
- ambari_repo_details_json.go
- ambari_stack_details.go
- blueprint_request.go
- blueprint_response.go
- certificate_response.go
- cloudbreak_details_json.go
- cloudbreak_event.go
- cloudbreak_usage.go
- cluster_request.go
- cluster_response.go
- constraint.go
- constraint_template_request.go
- constraint_template_response.go
- credential_request.go
- credential_response.go
- failure_policy.go
- file_system.go
- host_group.go
- host_group_adjustment.go
- host_metadata.go
- id.go
- image_json.go
- instance_group.go
- instance_group_adjustment.go
- instance_meta_data.go
- ldap_config_request.go
- ldap_config_response.go
- network_json.go
- orchestrator_request.go
- orchestrator_response.go
- platform_variants_json.go
- r_d_s_config.go
- r_d_s_config_response.go
- rds_test_result.go
- recipe_request.go
- recipe_response.go
- security_group_json.go
- security_rule.go
- sssd_config_request.go
- sssd_config_response.go
- stack_request.go
- stack_response.go
- stack_validation_request.go
- template_request.go
- template_response.go
- topology_request.go
- topology_response.go
- update_cluster.go
- update_stack.go
- user.go
- user_name_password_json.go