Documentation
¶
Index ¶
- Constants
- type APIExtension
- type Application
- type ApplicationDependency
- type ApplicationProfile
- type ArtifactReference
- type DeploymentProfile
- type DeploymentRequirement
- type Endpoint
- type Namespace
- type ParameterTemplate
- type Profile
- type ResourceReference
- type UIExtension
- type YamlSpec
- type YamlSpecs
Constants ¶
const ( DeploymentPackageType = "DeploymentPackage" DeploymentPackageLegacyType = "Deployment-Package" ApplicationType = "Application" ArtifactType = "Artifact" RegistryType = "Registry" Quot = `'` )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIExtension ¶
type APIExtension struct {
Name string `yaml:"name,omitempty"`
Version string `yaml:"version,omitempty"`
DisplayName string `yaml:"displayName,omitempty"`
Description string `yaml:"description,omitempty"`
Endpoints []*Endpoint `yaml:"endpoints,omitempty"`
UIExtension *UIExtension `yaml:"uiExtension,omitempty"`
}
APIExtension is a structure for loading API extensions
type Application ¶
type Application struct {
Publisher string `yaml:"publisher,omitempty"`
Name string `yaml:"name,omitempty"`
Version string `yaml:"version,omitempty"`
}
Application is a structure for loading application references, e.g. name/version pairs when defining a DeploymentPackages
type ApplicationDependency ¶
ApplicationDependency holds dependencies to applications
type ApplicationProfile ¶
type ApplicationProfile struct {
ApplicationName string `yaml:"application,omitempty"`
ProfileName string `yaml:"profile,omitempty"`
}
ApplicationProfile is a structure for loading application profiles, i.e. application/profile bindings when defining DeploymentProfiles
type ArtifactReference ¶
type ArtifactReference struct {
Publisher string `yaml:"publisher,omitempty"`
Name string `yaml:"name,omitempty"`
Purpose string `yaml:"purpose,omitempty"`
}
ArtifactReference holds label and service information for UI extensions
type DeploymentProfile ¶
type DeploymentProfile struct {
Name string `yaml:"name,omitempty"`
DisplayName string `yaml:"displayName,omitempty"`
Description string `yaml:"description,omitempty"`
ApplicationProfiles []ApplicationProfile `yaml:"applicationProfiles,omitempty"`
}
DeploymentProfile is a structure for loading deployment package profiles.
type DeploymentRequirement ¶
type DeploymentRequirement struct {
Publisher string `yaml:"publisher,omitempty"`
Name string `yaml:"name,omitempty"`
Version string `yaml:"version,omitempty"`
DeploymentProfile string `yaml:"deploymentProfileName,omitempty"`
}
DeploymentRequirement is a structure for specifying deployment requirements of an application profile.
type Endpoint ¶
type Endpoint struct {
ServiceName string `yaml:"serviceName,omitempty"`
ExternalPath string `yaml:"externalPath,omitempty"`
InternalPath string `yaml:"internalPath,omitempty"`
Scheme string `yaml:"scheme,omitempty"`
AuthType string `yaml:"authType,omitempty"`
AppName string `yaml:"appName,omitempty"`
}
Endpoint is a structure for loading extension endpoints
type Namespace ¶
type Namespace struct {
Name string `yaml:"name,omitempty"`
Labels map[string]string `yaml:"labels,omitempty"`
Annotations map[string]string `yaml:"annotations,omitempty"`
}
Namespace is a structure for loading deployment package required namespaces.
type ParameterTemplate ¶
type ParameterTemplate struct {
Name string `yaml:"name,omitempty"`
DisplayName string `yaml:"displayName,omitempty"`
Type string `yaml:"type,omitempty"`
Default string `yaml:"default,omitempty"`
Validator string `yaml:"validator,omitempty"`
SuggestedValues []string `yaml:"suggestedValues,omitempty"`
Secret bool `yaml:"secret,omitempty"`
Mandatory bool `yaml:"mandatory,omitempty"`
}
ParameterTemplate is a structure for loading ignores resources of an application.
type Profile ¶
type Profile struct {
Name string `yaml:"name,omitempty"`
DisplayName string `yaml:"displayName,omitempty"`
Description string `yaml:"description,omitempty"`
ValuesFileName string `yaml:"valuesFileName,omitempty"`
ParameterTemplates []ParameterTemplate `yaml:"parameterTemplates,omitempty"`
DeploymentRequirements []DeploymentRequirement `yaml:"deploymentRequirements,omitempty"`
}
Profile is a structure for loading application deployment values
type ResourceReference ¶
type ResourceReference struct {
Name string `yaml:"name,omitempty"`
Kind string `yaml:"kind,omitempty"`
Namespace string `yaml:"namespace,omitempty"`
}
ResourceReference is a structure for loading ignores resources of an application.
type UIExtension ¶
type UIExtension struct {
ServiceName string `yaml:"serviceName,omitempty"`
Description string `yaml:"description,omitempty"`
Label *string `yaml:"label,omitempty"`
FileName string `yaml:"fileName,omitempty"`
AppName string `yaml:"appName,omitempty"`
ModuleName string `yaml:"moduleName,omitempty"`
}
UIExtension holds label and service information for UI extensions
type YamlSpec ¶
type YamlSpec struct {
FileName string `yaml:"filename,omitempty"`
SpecSchema string `yaml:"specSchema,omitempty"`
SchemaVersion string `yaml:"schemaVersion,omitempty"`
Name string `yaml:"name,omitempty"`
DisplayName string `yaml:"displayName,omitempty"`
Version string `yaml:"version,omitempty"`
Kind string `yaml:"kind,omitempty"`
Description string `yaml:"description"` // TODO: should be optional, but a bug in upload API requires it to be present
HelmRegistry string `yaml:"helmRegistry,omitempty"`
Type string `yaml:"type,omitempty"`
ChartName string `yaml:"chartName,omitempty"`
ChartVersion string `yaml:"chartVersion,omitempty"`
ImageRegistry string `yaml:"imageRegistry,omitempty"`
MimeType string `yaml:"mimeType,omitempty"`
Artifact string `yaml:"artifact,omitempty"`
RootURL string `yaml:"rootUrl,omitempty"`
InventoryURL string `yaml:"inventoryUrl,omitempty"`
APIType string `yaml:"apiType,omitempty"`
UserName string `yaml:"userName,omitempty"`
AuthToken string `yaml:"authToken,omitempty"`
CACerts string `yaml:"caCerts,omitempty"`
Profiles []Profile `yaml:"profiles,omitempty"`
DeploymentProfiles []DeploymentProfile `yaml:"deploymentProfiles,omitempty"`
DefaultProfile string `yaml:"defaultProfile,omitempty"`
Applications []Application `yaml:"applications,omitempty"`
ApplicationDependencies []ApplicationDependency `yaml:"applicationDependencies,omitempty"`
Extensions []APIExtension `yaml:"extensions,omitempty"`
Artifacts []ArtifactReference `yaml:"artifacts,omitempty"`
DefaultNamespaces map[string]string `yaml:"defaultNamespaces,omitempty"`
Namespaces []Namespace `yaml:"namespaces,omitempty"`
IgnoredResources []ResourceReference `yaml:"ignoredResources,omitempty"`
IsVisible bool `yaml:"isVisible,omitempty"`
IsDeployed bool `yaml:"isDeployed,omitempty"`
ForbidsMultipleDeployments bool `yaml:"forbidsMultipleDeployments,omitempty"`
Registry string `yaml:"registry,omitempty"` // deprecated in lieu of 'helmRegistry'
ArtifactReferences []ArtifactReference `yaml:"artifactReferences,omitempty"` // deprecated in lieu of 'artifacts'
RegistryType string `yaml:"registryType,omitempty"` // deprecated in lieu of 'type'
}
YamlSpec is a main structure for loading application catalog entities.
func (YamlSpec) GetArtifacts ¶
func (ys YamlSpec) GetArtifacts() []ArtifactReference
GetArtifacts retrieves the artifact references in a backwards compatible manner, drawing on deprecated ArtifactReferences field if the Artifacts field is empty
func (YamlSpec) GetHelmRegistry ¶
GetHelmRegistry retrieves the Helm registry in a backwards compatible manner, drawing on deprecated Registry field if the HelmRegistry field is empty
func (YamlSpec) GetRegistryType ¶
GetRegistryType retrieves the registry type in a backwards compatible manner, drawing on deprecated RegistryType field if the Type field is empty
type YamlSpecs ¶
type YamlSpecs []YamlSpec
YamlSpecs is a collection of YamlSpec structures