application

package
v0.15.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 3, 2018 License: MPL-2.0 Imports: 12 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContainerContainerPath is the uri path for containers
	ContainerContainerPath = "/paas/service/apaas/api/v1.1/apps/%s"
	// ContainerResourcePath is the uri path for a specific container resource
	ContainerResourcePath = "/paas/service/apaas/api/v1.1/apps/%s/%s"
)

Functions

This section is empty.

Types

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client represents an authenticated application client, with credentials and an api client.

func NewClient 

func NewClient(c *opc.Config) (*Client, error)

NewClient returns a new client for the application resources managed by Oracle

func (*Client) ContainerClient 

func (c *Client) ContainerClient() *ContainerClient

ContainerClient obtains an ApplicationClient which can be used to access to the Application Container functions of the Application Container API

type Container 

type Container struct {
	// ID of the application
	AppID string `json:"appId"`
	// URL of the created application
	AppURL string `json:"appURL"`
	// Creation time of the application
	CreatedTime string `json:"createdTime"`
	// The activity acting on the application container
	CurrentOnGoingActitvity string `json:"currentOngoingActivity"`
	// Identity Domain of the application
	IdentityDomain string `json:"identityDomain"`
	// Shows details of all instances currently running.
	Instances []Instance `json:"instances"`
	// Modification time of the application
	LastModifiedTime string `json:"lastModifiedTime"`
	// Shows all deployments currently in progress.
	LatestDeployment Deployment `json:"latestDeployment"`
	// Name of the application
	Name string `json:"name"`
	// Shows all deployments currently running.
	RunningDeployment Deployment `json:"runningDeployment"`
	// Status of the application
	Status string `json:"status"`
	// Type of subscription, Hourly or Monthly
	SubscriptionType SubscriptionType `json:"subscriptionType"`
	// Web URL of the application
	WebURL string `json:"webURL"`
}

Container container information about the application container

type ContainerClient 

type ContainerClient struct {
	ResourceClient
	PollInterval time.Duration
	Timeout      time.Duration
}

ContainerClient is a client for the Application container functions of the Application Container API

func (*ContainerClient) CreateApplicationContainer 

func (c *ContainerClient) CreateApplicationContainer(input *CreateApplicationContainerInput) (*Container, error)

CreateApplicationContainer creates a new Application Container from an ApplicationClient and an input struct. Returns a populated ApplicationContainer struct for the Application, and any errors

func (*ContainerClient) DeleteApplicationContainer 

func (c *ContainerClient) DeleteApplicationContainer(input *DeleteApplicationContainerInput) error

DeleteApplicationContainer deletes the application container with the given name.

func (*ContainerClient) GetApplicationContainer 

func (c *ContainerClient) GetApplicationContainer(getInput *GetApplicationContainerInput) (*Container, error)

GetApplicationContainer retrieves the application container with the given name.

func (*ContainerClient) UpdateApplicationContainer 

func (c *ContainerClient) UpdateApplicationContainer(input *UpdateApplicationContainerInput) (*Container, error)

UpdateApplicationContainer updates an application container from an ApplicationClient and an input struct. Returns a populated ApplicationContainer struct for the Application, and any errors

func (*ContainerClient) WaitForApplicationContainerDeleted 

func (c *ContainerClient) WaitForApplicationContainerDeleted(input *DeleteApplicationContainerInput, pollInterval, timeout time.Duration) error

WaitForApplicationContainerDeleted waits for an application container to be fully deleted.

func (*ContainerClient) WaitForApplicationContainerRunning 

func (c *ContainerClient) WaitForApplicationContainerRunning(input *GetApplicationContainerInput, pollInterval, timeoutSeconds time.Duration) (*Container, error)

WaitForApplicationContainerRunning waits for an application container to be completely initialized and ready.

type CreateApplicationContainerAdditionalFields 

type CreateApplicationContainerAdditionalFields struct {
	// Location of the application archive file in Oracle Storage Cloud Service, in the format app-name/file-name
	// Optional
	ArchiveURL string `json:"archiveURL"`
	// Uses Oracle Identity Cloud Service to control who can access your Java SE 7 or 8, Node.js, or PHP application.
	// This should be ApplicationContainerAuthType but because of how we need to translate this strut to a map[string]string we are keeping it as a string
	// Allowed values are 'basic' and 'oauth'.
	// Optional
	AuthType string `json:"authType"`
	// Comma separated name of one or more data center locations in the Oracle Cloud Infrastructure region.
	// A region is a localized geographic area, composed of one or more availability domains (data centers).
	// Optional. Required only on Oracle Cloud Infrastructure
	AvailabilityDomain string `json:availabilityDomain`
	// The password of your GitHub repository, required if your repository is private.
	// Optional
	GitPassword string `json:"gitPassword"`
	// URL of your GitHub repository.
	GitRepoURL string `json:"gitRepoUrl"`
	// The user name of your GitHub repository, required if your repository is private.
	GitUsername string `json:"gitUserName"`
	// Two comma separated load balancer subnets.
	// Optional. Required only on Oracle Cloud Infrastructure.
	LoadBalancerSubnets string `json:"lbsubnet"`
	// Name of the application
	// Required
	Name string `json:"name"`
	// Comments on the application deployment
	Notes string `json:"notes"`
	// Email address to which application deployment status updates are sent.
	NotificationEmail string `json:"notifcationEmail"`
	// Name of the region where the application is to be provisioned.
	// Optional. Required only on Oracle Cloud Infrastructure.
	Region string `json:"region"`
	// Repository of the application. The only allowed value is 'dockerhub'.
	// This should be ApplicationRepository but because of how we need to translate this strut to a map[string]string we are keeping it as a string
	// Optional
	Repository string `json:"repository"`
	// Runtime environment: java (the default), node, php, python, or ruby
	// This should be ApplicationRuntime but because of how we need to translate this strut to a map[string]string we are keeping it as a string
	// Required
	Runtime string `json:"runtime"`
	// Subscription, either hourly (the default) or monthly
	// This should be ApplicationSubscriptionType but because of how we need to translate this strut to a map[string]string we are keeping it as a string
	// Optional
	SubscriptionType string `json:"subscription"`
	// List of tags that can be associated with the application.
	Tags []Tag `json:"tags"`
}

CreateApplicationContainerAdditionalFields specifies the additional fields needed to create an application container

type CreateApplicationContainerInput 

type CreateApplicationContainerInput struct {
	// The additional fields needed for ApplicationContainer
	AdditionalFields CreateApplicationContainerAdditionalFields
	// Name of the optional deployment file, which specifies memory, number of instances, and service bindings
	// Optional
	Deployment string
	// Deployment Attributes
	// Optional
	DeploymentAttributes *DeploymentAttributes
	// Name of the manifest file, required if this file is not packaged with the application
	// Optional
	Manifest string
	// Manifest Attributes
	// Optional
	ManifestAttributes *ManifestAttributes
	// Time to wait between checks on application container status
	PollInterval time.Duration
	// Timeout for creating an application container
	Timeout time.Duration
}

CreateApplicationContainerInput specifies the information needed to create an application container

type DeleteApplicationContainerInput 

type DeleteApplicationContainerInput struct {
	// Name of the application container
	// Required
	Name string `json:"name"`
	// Time to wait between checks on application container status
	PollInterval time.Duration
	// Timeout to delete an application container
	Timeout time.Duration
}

DeleteApplicationContainerInput specifies the information needed to delete an application container

type Deployment 

type Deployment struct {
	// Deployment ID. Use this ID to manage a specific deployment.
	DeploymentID string `json:"deploymentId"`
	// Status of the deployment
	DeploymentStatus string `json:"deploymentStatus"`
	// Deployment URL. Use this URL to get a description of the application deployment.
	DeploymentURL string `json:"deploymentURL"`
}

Deployment specifies individual deployment information on the application container

type DeploymentAttributes added in v0.11.0 

type DeploymentAttributes struct {
	// The amount of memory in gigabytes made available to the application. Values range from 1G to 20G.
	// The default is 2G.
	// Optional
	Memory string `json:"memory,omitempty"`
	// Number of application instances. The maximum is 64.
	// The default is 2.
	// Optional
	Instances int `json:"instances,omitempty"`
	// Free-form comment field. It can be used, for example, to describe the deployment plan.
	// Optional
	Notes string `json:"notes,omitempty"`
	// Environment variables used by the application. This element can contain any number of name-value pairs.
	// Optional
	Envrionment map[string]string `json:"environment,omitempty"`
	// List of environment variables marked as secured on the user interface.
	// The environment variables to be secured must be present in the environment property.
	// Optional
	SecureEnvironment []string `json:"secureEnvironment,omitempty"`
	// Java EE system properties used by the application. This element can contain any number of name-value pairs.
	// Optional
	JavaSystemProperties map[string]string `json:"java_system_properties,omitempty"`
	// Service bindings for connections to other Oracle Cloud services. This element can contain more
	// than one block of sub-elements. Each block specifies one service binding.
	// Optional
	Services []Service `json:"services,omitempty"`
}

DeploymentAttributes details the attributes available for a deployment.json file

type GetApplicationContainerInput 

type GetApplicationContainerInput struct {
	// Name of the application container
	// Required
	Name string `json:"name"`
}

GetApplicationContainerInput specifies the information needed to get an application container

type HealthCheck added in v0.11.0 

type HealthCheck struct {
	// Defines the URI that is appended to the application URL to create the health check URL
	HTTPEndpoint string `json:"http-endpoint"`
}

HealthCheck specifies the available attributes for a health check

type Instance 

type Instance struct {
	// Instance URL. Use this url to get a description of the application instance.
	InstanceURL string `json:"instanceURL"`
	// Memory of the instance
	Memory string `json:"memory"`
	// Instance Name. Use this name to manage a specific instance.
	Name string `json:"name"`
	// Status of the instance
	Status string `json:"status"`
}

Instance specifies individual instance information on the application container

type ManifestAttributes added in v0.11.0 

type ManifestAttributes struct {
	// Optional
	Runtime *Runtime `json:"runtime,omitempty"`
	// Determines whether an application is public or private
	// Default is `worker`
	// Optional
	Type ManifestType `json:"type,omitempty"`
	// Launch command to execute after the application has been uploaded.
	// Optional
	Command string `json:"command,omitempty"`
	// Release attributes of a specific build.
	// Optional
	Release *Release `json:"release,omitempty"`
	// Maximum time in seconds to wait for the application to start. Allowed values are between 10 and 600. The default is 30.
	// If the application doesn’t start in the time specified, the application is deemed to have failed to start and is terminated.
	// For example, if your application takes two minutes to start, set startupTime to at least 120.
	// Optional
	StartupTime string `json:"startupTime,omitempty"`
	// Maximum time in seconds to wait for the application to stop. Allowed values are between 0 and 600.
	// The default is 0. This allows the application to close connections and free up resources gracefully.
	// For example, if your application takes two minutes to shut down, set shutdownTime to at least 120.
	// Optional
	ShutdownTime string `json:"shutdownTime,omitempty"`
	// Comments
	// Optional
	Notes string `json:"notes,omitempty"`
	// Restart mode for application instances when the application is restarted. The only allowed option is rolling for a rolling restart.
	// Omit this parameter to be prompted for a rolling or concurrent restart.
	// Optional
	Mode ManifestMode `json:"mode,omitempty"`
	// Must be set to true for application instances to act as a cluster, with failover capability.
	// Optional
	IsClustered bool `json:"isClustered,omitempty"`
	// Context root of the application. The value of the home parameter is appended to the application URL.
	// Optional
	Home string `json:"home,omitempty"`
	// Allows you to define a URL for your application that the system uses for health checks. The URL must return an HTTP response of 200 OK to indicate that the application is healthy.
	// Optional
	HealthCheck HealthCheck `json:"healthcheck,omitempty"`
}

ManifestAttributes details the available attributes in a manifest file

type ManifestMode added in v0.11.0 

type ManifestMode string

ManifestMode details the optional modes for restarting the application container 

const (
	// ManifestModeRolling performs a rolling restart
	ManifestModeRolling ManifestMode = "rolling"
)

type ManifestType added in v0.11.0 

type ManifestType string

ManifestType determines whether an application is public or private: 

const (
	// ManifestTypeWeb specifies a public application, which you can access using a public URL, the public REST API, or the command-line interface.
	ManifestTypeWeb ManifestType = "web"
	// ManifestTypeWorker specifies a worker application, which is private and runs in the background. The isClustered parameter should be set to true in some cases.
	ManifestTypeWorker ManifestType = "worker"
)

type Release added in v0.11.0 

type Release struct {
	// User-specified value of build.
	// Required
	Build string `json:"build"`
	// User-specified value of commit.
	// Required
	Commit string `json:"commit"`
	// User-specified application version.
	// Required
	Version string `json:"version"`
}

Release details the attributes for a specific release for the application container.

type ResourceClient 

type ResourceClient struct {
	*Client
	ContainerPath    string
	ResourceRootPath string
}

ResourceClient is an AuthenticatedClient with some additional information about the resources to be addressed.

type Runtime added in v0.11.0 

type Runtime struct {
	MajorVersion string `json:"majorVersion"`
}

Runtime details the available runtime attributes for a manifest file

type Service added in v0.11.0 

type Service struct {
	// User-specified identifier.
	// Required
	Identifier string `json:"identifier"`
	// Type of the service.
	// Required
	Type ServiceType `json:"type"`
	// Name of the service, the name of an existing Oracle Java Cloud Service instance, Oracle Database Cloud
	// Service database, MySQL Cloud Service database, Oracle Event Hub Cloud Service topic or cluster,
	// Oracle Data Hub Cloud Service instance, or cache name.
	// Required
	Name string `json:"name"`
	// Username used to access the service.
	// Required
	Username string `json:"username"`
	// Password for the username.
	// Required
	Password string `json:"password"`
}

Service details the service bindings for connections to other Oracle Cloud services.

type ServiceType added in v0.11.0 

type ServiceType string

ServiceType details the constants related to what types a service is 

const (
	// ServiceTypeJAAS for Oracle Java Cloud Service
	ServiceTypeJAAS ServiceType = "JAAS"
	// ServiceTypeDBAAS for Oracle Database Cloud Service
	ServiceTypeDBAAS ServiceType = "DBAAS"
	// ServiceTypeMYSQLCS for MySQL Cloud Service
	ServiceTypeMYSQLCS ServiceType = "MYSQLCS"
	// ServiceTypeOEHCS for an Oracle Event Hub Cloud Service topic
	ServiceTypeOEHCS ServiceType = "OEHCS"
	// ServiceTypeOEHPCS for an Oracle Event Hub Cloud Service cluster
	ServiceTypeOEHPCS ServiceType = "OEHPCS"
	// ServiceTypeDHCS for Oracle Data Hub Cloud Service
	ServiceTypeDHCS ServiceType = "DHCS"
	// ServiceTypeCaching for a cache
	ServiceTypeCaching ServiceType = "caching"
)

type SubscriptionType 

type SubscriptionType string

SubscriptionType are the values available for subscription 

const (
	// SubscriptionTypeHourly specifies that the subscription is metered hourly
	SubscriptionTypeHourly SubscriptionType = "HOURLY"
	// SubscriptionTypeMonthly specifies that the subscription is metered monthly
	SubscriptionTypeMonthly SubscriptionType = "MONTHLY"
)

type Tag added in v0.12.0 

type Tag struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

Tag defines the attributes related to a tag

type UpdateApplicationContainerAdditionalFields 

type UpdateApplicationContainerAdditionalFields struct {
	// Location of the application archive file in Oracle Storage Cloud Service, in the format app-name/file-name
	// Optional
	ArchiveURL string
	// Comments on the application deployment
	Notes string
}

UpdateApplicationContainerAdditionalFields specifies the additional fields needed to update an application container

type UpdateApplicationContainerInput 

type UpdateApplicationContainerInput struct {
	// Name of the application container
	Name string
	// The additional fields needed for ApplicationContainer
	AdditionalFields UpdateApplicationContainerAdditionalFields
	// Name of the optional deployment file, which specifies memory, number of instances, and service bindings
	// Optional
	Deployment string
	// Deployment Attributes
	// Optional
	DeploymentAttributes *DeploymentAttributes
	// Name of the manifest file, required if this file is not packaged with the application
	// Optional
	Manifest string
	// Manifest Attributes
	ManifestAttributes *ManifestAttributes
	// Time to wait between checks on application container status
	PollInterval time.Duration
	// Timeout for creating an application container
	Timeout time.Duration
}

UpdateApplicationContainerInput specifies the fields needed to update an application container

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.