Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the microfrontend v1alpha1 API group +kubebuilder:object:generate=true +groupName=microfrontend.michalsevcik.dev
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // GroupVersion is group version used to register these objects GroupVersion = schema.GroupVersion{Group: "microfrontend.michalsevcik.dev", Version: "v1alpha1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
This section is empty.
Types ¶
type Attribute ¶
type Attribute struct { // +operator-sdk:csv:customresourcedefinitions:type=spec Name string `json:"name"` // +kubebuilder:validation:XPreserveUnknownFields // +kubebuilder:validation:Schemaless // +operator-sdk:csv:customresourcedefinitions:type=spec Value runtime.RawExtension `json:"value"` }
func (*Attribute) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Attribute.
func (*Attribute) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ContextElement ¶
type ContextElement struct { // This is a list of context names in which this element is intended to be shown. // +operator-sdk:csv:customresourcedefinitions:type=spec ContextNames []string `json:"context-names"` // This is the HTML element tag name to use when navigating to the specific path. // +kubebuilder:example="my-menu-item" // +operator-sdk:csv:customresourcedefinitions:type=spec Element string `json:"element"` // This indicates the priority of the navigation entry in lists. Entries with higher priority are displayed before entries with lower priorities, if there is an ordering supported by the list. The default priority is 0. // +kubebuilder:default=0 // +operator-sdk:csv:customresourcedefinitions:type=spec Priority *int `json:"priority,omitempty"` // This is a list of key-value pairs that allows you to assign specific attributes to the element. The name field is used as the attribute name, while the value field can be any valid JSON type. // +operator-sdk:csv:customresourcedefinitions:type=spec Attributes []Attribute `json:"attributes,omitempty"` // +operator-sdk:csv:customresourcedefinitions:type=spec Roles []string `json:"roles,omitempty"` }
func (*ContextElement) DeepCopy ¶
func (in *ContextElement) DeepCopy() *ContextElement
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ContextElement.
func (*ContextElement) DeepCopyInto ¶
func (in *ContextElement) DeepCopyInto(out *ContextElement)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Icon ¶
type Icon struct { // +operator-sdk:csv:customresourcedefinitions:type=spec Mime string `json:"mime"` // +kubebuilder:Validation:Format=byte // +operator-sdk:csv:customresourcedefinitions:type=spec Data string `json:"data,omitempty"` // +kubebuilder:Validation:Format=url // +operator-sdk:csv:customresourcedefinitions:type=spec Url string `json:"url,omitempty"` }
func (*Icon) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Icon.
func (*Icon) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type Navigation ¶
type Navigation struct { // +kubebuilder:example="/my-menu-item" // +operator-sdk:csv:customresourcedefinitions:type=spec Path string `json:"path"` // +kubebuilder:example="My Menu Item" // +operator-sdk:csv:customresourcedefinitions:type=spec Title string `json:"title"` // +kubebuilder:default=0 // +operator-sdk:csv:customresourcedefinitions:type=spec Priority *int `json:"priority,omitempty"` // +operator-sdk:csv:customresourcedefinitions:type=spec Details string `json:"details,omitempty"` // +kubebuilder:example="my-menu-item" // +operator-sdk:csv:customresourcedefinitions:type=spec Element string `json:"element"` // +operator-sdk:csv:customresourcedefinitions:type=spec Attributes []Attribute `json:"attributes,omitempty"` // +operator-sdk:csv:customresourcedefinitions:type=spec Icon *Icon `json:"icon,omitempty"` Roles []string `json:"roles,omitempty"` }
func (*Navigation) DeepCopy ¶
func (in *Navigation) DeepCopy() *Navigation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Navigation.
func (*Navigation) DeepCopyInto ¶
func (in *Navigation) DeepCopyInto(out *Navigation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WebComponent ¶
type WebComponent struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec WebComponentSpec `json:"spec"` Status WebComponentStatus `json:"status,omitempty"` }
WebComponent is the Schema for the webcomponents API +kubebuilder:subresource:status +kubebuilder:resource:shortName=webc
func (*WebComponent) DeepCopy ¶
func (in *WebComponent) DeepCopy() *WebComponent
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WebComponent.
func (*WebComponent) DeepCopyInto ¶
func (in *WebComponent) DeepCopyInto(out *WebComponent)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*WebComponent) DeepCopyObject ¶
func (in *WebComponent) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type WebComponentList ¶
type WebComponentList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []WebComponent `json:"items"` }
WebComponentList contains a list of WebComponent
func (*WebComponentList) DeepCopy ¶
func (in *WebComponentList) DeepCopy() *WebComponentList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WebComponentList.
func (*WebComponentList) DeepCopyInto ¶
func (in *WebComponentList) DeepCopyInto(out *WebComponentList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*WebComponentList) DeepCopyObject ¶
func (in *WebComponentList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type WebComponentSpec ¶
type WebComponentSpec struct { // The URI from which the module shall be accessed. The actual module is cached by the controller to improve performance and avoid CORS issues. // +kubebuilder:validation:Format=url // +operator-sdk:csv:customresourcedefinitions:type=spec ModuleUri string `json:"module-uri"` // The modules are not preloaded by default but only when navigating to some of the subpaths mentioned in the 'navigation' list. Setting this property to true ensures that the module is loaded when the application starts. // +kubebuilder:default=false // +operator-sdk:csv:customresourcedefinitions:type=spec Preload *bool `json:"preload,omitempty"` // This specifies whether the loading of web components should be proxied by the controller. This is useful if the web component is served from within the cluster and cannot be accessed from outside the cluster network. The module will be served from the URL base_controller_url/web-components/web_component_name.jsm. This is the recommended approach for the standard assumed use-case. // +kubebuilder:default=true // +operator-sdk:csv:customresourcedefinitions:type=spec Proxy *bool `json:"proxy,omitempty"` // A hash string used to identify a specific version of the module URI when the controller is proxying it. If the proxy property is set and the hash property is set as well, the final module file name will be web_component_name.hash_suffix.jsm, and the resource will be assumed to never expire. To refresh user agents' caches, the hash value needs to be changed to a new unique value. // +operator-sdk:csv:customresourcedefinitions:type=spec HashSuffix string `json:"hash-suffix,omitempty"` // An array of relative paths (relative to module-uri) that contains the CSS styles required for this web component module. Ideally, the styles are either embedded in or loaded by the module. However, certain legacy styles may require an additional link element. // +operator-sdk:csv:customresourcedefinitions:type=spec StyleRelativePaths []string `json:"style-relative-paths,omitempty"` // These are components that can be displayed in a special context, such as ufe-app-shell for the top-level application shell or my-menu-item for components to be displayed in a custom menu, and so on. // +operator-sdk:csv:customresourcedefinitions:type=spec ContextElements []ContextElement `json:"context-elements,omitempty"` // +operator-sdk:csv:customresourcedefinitions:type=spec Navigations []Navigation `json:"navigations,omitempty"` }
WebComponentSpec defines the desired state of WebComponent
func (*WebComponentSpec) DeepCopy ¶
func (in *WebComponentSpec) DeepCopy() *WebComponentSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WebComponentSpec.
func (*WebComponentSpec) DeepCopyInto ¶
func (in *WebComponentSpec) DeepCopyInto(out *WebComponentSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type WebComponentStatus ¶
type WebComponentStatus struct { }
WebComponentStatus defines the observed state of WebComponent
func (*WebComponentStatus) DeepCopy ¶
func (in *WebComponentStatus) DeepCopy() *WebComponentStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new WebComponentStatus.
func (*WebComponentStatus) DeepCopyInto ¶
func (in *WebComponentStatus) DeepCopyInto(out *WebComponentStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.