io.github.microcks.operator.api.base.v1alpha1.MongoDBSpec Maven / Gradle / Ivy

Go to download
/*
 * Copyright The Microcks Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.github.microcks.operator.api.base.v1alpha1;

import io.github.microcks.operator.api.model.ImageSpec;
import io.github.microcks.operator.api.model.SecretReferenceSpec;

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonPropertyDescription;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import io.fabric8.kubernetes.api.model.PodSecurityContext;
import io.fabric8.kubernetes.api.model.ResourceRequirements;
import io.sundr.builder.annotations.Buildable;

import java.util.Map;

/**
 * Representation of the MongoDB part of an operator-managed Microcks installation.
 * @author laurent
 */
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonPropertyOrder({ "install", "image", "uri", "uriParameters", "database", "secretRef", "resources", "persistent",
      "volumeSize", "storageClassName", "pvcAnnotations" })
@Buildable(editableEnabled = false, builderPackage = "io.fabric8.kubernetes.api.builder")
public class MongoDBSpec {

   @JsonPropertyDescription("Install MongoDB or reuse an existing instance? Default to true.")
   private boolean install = true;

   @JsonPropertyDescription("The container image to use for MongoDB")
   private ImageSpec image;

   @JsonProperty("uri")
   @JsonPropertyDescription("MongoDB root URI to use for access")
   private String uri;

   @JsonPropertyDescription("Parameters added to MongoDB URI connection string. Only if install if false.")
   private String uriParameters;

   @JsonPropertyDescription("MongoDB database name in case you're reusing existing one. Only if install if false.")
   private String database;

   @JsonPropertyDescription("Reference of a Secret containing username and password keys for connecting to existing MongoDB instance")
   private SecretReferenceSpec secretRef;

   @JsonPropertyDescription("Kubernetes resource requirements for MongoDB")
   private ResourceRequirements resources;

   @JsonPropertyDescription("Security context for MongoDB deployment")
   private PodSecurityContext securityContext;

   @JsonPropertyDescription("Use persistent storage or ephemeral one? Default to true")
   private boolean persistent = true;

   @JsonPropertyDescription("Size of persistent storage volume if persistent")
   private String volumeSize;

   @JsonPropertyDescription("Name of storage class to use if not relying on default")
   private String storageClassName;

   @JsonPropertyDescription("Annotations to be added to managed Persistent Volume Claim")
   private Map pvcAnnotations;

   public boolean isInstall() {
      return install;
   }

   public void setInstall(boolean install) {
      this.install = install;
   }

   public ImageSpec getImage() {
      return image;
   }

   public void setImage(ImageSpec image) {
      this.image = image;
   }

   public String getUri() {
      return uri;
   }

   public void setUri(String uri) {
      this.uri = uri;
   }

   public String getUriParameters() {
      return uriParameters;
   }

   public void setUriParameters(String uriParameters) {
      this.uriParameters = uriParameters;
   }

   public String getDatabase() {
      return database;
   }

   public void setDatabase(String database) {
      this.database = database;
   }

   public SecretReferenceSpec getSecretRef() {
      return secretRef;
   }

   public void setSecretRef(SecretReferenceSpec secretRef) {
      this.secretRef = secretRef;
   }

   public ResourceRequirements getResources() {
      return resources;
   }

   public void setResources(ResourceRequirements resources) {
      this.resources = resources;
   }

   public PodSecurityContext getSecurityContext() {
      return securityContext;
   }

   public void setSecurityContext(PodSecurityContext securityContext) {
      this.securityContext = securityContext;
   }

   public boolean isPersistent() {
      return persistent;
   }

   public void setPersistent(boolean persistent) {
      this.persistent = persistent;
   }

   public String getVolumeSize() {
      return volumeSize;
   }

   public void setVolumeSize(String volumeSize) {
      this.volumeSize = volumeSize;
   }

   public String getStorageClassName() {
      return storageClassName;
   }

   public void setStorageClassName(String storageClassName) {
      this.storageClassName = storageClassName;
   }

   public Map getPvcAnnotations() {
      return pvcAnnotations;
   }

   public void setPvcAnnotations(Map pvcAnnotations) {
      this.pvcAnnotations = pvcAnnotations;
   }
}