Documentation
¶
Overview ¶
Package nginx provides resource management utilities for creating and updating Kubernetes resources (Deployments, Services, ConfigMaps) that represent NGINX instances managed by the operator.
Usage:
mgr := nginx.NewResourceManager(client, scheme) deployment := mgr.BuildDeployment(server) service := mgr.BuildService(server)
Index ¶
- func ConfDConfigMapName(server *nginxv1alpha1.NginxServer) string
- func ConfigMapName(server *nginxv1alpha1.NginxServer) string
- func DeploymentName(server *nginxv1alpha1.NginxServer) string
- func ServiceName(server *nginxv1alpha1.NginxServer) string
- type ResourceManager
- func (m *ResourceManager) BuildConfDConfigMap(server *nginxv1alpha1.NginxServer, serverConfigs map[string]string) *corev1.ConfigMap
- func (m *ResourceManager) BuildConfigMap(server *nginxv1alpha1.NginxServer, mainConfig string, ...) *corev1.ConfigMap
- func (m *ResourceManager) BuildDeployment(server *nginxv1alpha1.NginxServer, reloaderTag string) *appsv1.Deployment
- func (m *ResourceManager) BuildService(server *nginxv1alpha1.NginxServer) *corev1.Service
- func (m *ResourceManager) SetOwnerReference(owner *nginxv1alpha1.NginxServer, controlled metav1.Object) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ConfDConfigMapName ¶ added in v0.1.7
func ConfDConfigMapName(server *nginxv1alpha1.NginxServer) string
ConfDConfigMapName returns the name for the conf.d server blocks ConfigMap.
func ConfigMapName ¶
func ConfigMapName(server *nginxv1alpha1.NginxServer) string
ConfigMapName returns the name for the main NGINX ConfigMap (nginx.conf).
func DeploymentName ¶
func DeploymentName(server *nginxv1alpha1.NginxServer) string
DeploymentName returns the name for the NGINX Deployment.
func ServiceName ¶
func ServiceName(server *nginxv1alpha1.NginxServer) string
ServiceName returns the name for the NGINX Service.
Types ¶
type ResourceManager ¶
type ResourceManager struct {
// contains filtered or unexported fields
}
ResourceManager creates and manages Kubernetes resources for NGINX instances.
func NewResourceManager ¶
func NewResourceManager(c client.Client, s *runtime.Scheme) *ResourceManager
NewResourceManager creates a new ResourceManager.
Usage:
mgr := nginx.NewResourceManager(k8sClient, scheme)
func (*ResourceManager) BuildConfDConfigMap ¶ added in v0.1.7
func (m *ResourceManager) BuildConfDConfigMap(server *nginxv1alpha1.NginxServer, serverConfigs map[string]string) *corev1.ConfigMap
BuildConfDConfigMap creates the conf.d ConfigMap containing server block configs. Each key becomes a .conf file inside /etc/nginx/conf.d/.
Usage:
cm := mgr.BuildConfDConfigMap(server, serverConfigs)
func (*ResourceManager) BuildConfigMap ¶
func (m *ResourceManager) BuildConfigMap(server *nginxv1alpha1.NginxServer, mainConfig string, serverConfigs map[string]string) *corev1.ConfigMap
BuildConfigMap creates the main ConfigMap containing nginx.conf.
Usage:
cm := mgr.BuildConfigMap(server, mainConfig)
func (*ResourceManager) BuildDeployment ¶
func (m *ResourceManager) BuildDeployment(server *nginxv1alpha1.NginxServer, reloaderTag string) *appsv1.Deployment
BuildDeployment creates a Deployment spec for the given NginxServer. The Deployment includes the NGINX container and a config-reloader sidecar.
Usage:
deployment := mgr.BuildDeployment(server, "v1.0.0")
func (*ResourceManager) BuildService ¶
func (m *ResourceManager) BuildService(server *nginxv1alpha1.NginxServer) *corev1.Service
BuildService creates a Service spec for the given NginxServer.
Usage:
service := mgr.BuildService(server)
func (*ResourceManager) SetOwnerReference ¶
func (m *ResourceManager) SetOwnerReference(owner *nginxv1alpha1.NginxServer, controlled metav1.Object) error
SetOwnerReference sets the owner reference on a controlled object to the NginxServer.
Usage:
err := mgr.SetOwnerReference(server, deployment)
Source Files