Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var CommonKeywords = []string{
"aws",
"amazon",
"ack",
}
CommonKeywords are keywords that are likely to be common across service controllers.
var CommonLinks = []opsv1alpha1.AppLink{
{
Name: "AWS Controllers for Kubernetes",
URL: "https://github.com/aws-controllers-k8s/community",
},
{
Name: "Documentation",
URL: "https://aws-controllers-k8s.github.io/community/",
},
}
CommonLinks are links that are likely to be common across service controllers.
Functions ¶
func BundleAssets ¶
func BundleAssets( m *ackmodel.Model, commonMeta CommonMetadata, serviceConfig ServiceConfig, vers string, templateBasePaths []string, ) (*templateset.TemplateSet, error)
BundleAssets generates the assets necessary to generate a bundle used for deploying a service via OLM.
Types ¶
type Annotations ¶
type Annotations struct {
CapabilityLevel string `json:"capabilityLevel"`
SuggestedNamespace string `json:"suggestedNamespace"`
Repository string `json:"repository"`
ContainerImage string `json:"containerImage"`
ShortDescription string `json:"shortDescription"`
Support string `json:"support"`
IsCertified bool `json:"isCertified"`
}
Annotations represent metadata that is added to the ClusterServiceVersion yaml. These keys inform the OLM graphical user interface.
type CommonMetadata ¶
type CommonMetadata struct {
Links []opsv1alpha1.AppLink `json:"links"`
Keywords []string `json:"keywords"`
}
CommonMetadata represents common metadata for all service controllers generated by this project.
type Sample ¶
type Sample struct {
Kind string `json:"kind"`
Spec string `json:"spec"`
DisplayName string `json:"displayName"`
Description string `json:"description"`
}
Sample is a basic representation of an instance of custom resource managed by a given service controller.
type ServiceConfig ¶
type ServiceConfig struct {
Annotations Annotations `json:"annotations"`
Samples []Sample `json:"samples"`
opsv1alpha1.ClusterServiceVersionSpec
}
ServiceConfig represents a service controller's OLM configuration input.
func DefaultServiceConfig ¶
func DefaultServiceConfig() ServiceConfig
DefaultServiceConfig returns a default representation of ServiceConfig to be used as a base. The various values are expected to be overridden (if needed) by an input YAML manifest for the given service controller.
Source Files