Package io.quarkus.kubernetes.deployment

Interface OpenShiftConfig

All Superinterfaces:
EnvVarHolder, PlatformConfiguration
@ConfigMapping(prefix="quarkus.openshift") @ConfigRoot(phase=BUILD_TIME) public interface OpenShiftConfig extends PlatformConfiguration
OpenShift

  • Method Details

    • targetPlatformName

      default String targetPlatformName()
      Description copied from interface: EnvVarHolder
      Specifies which the name of the platform this EnvVarHolder targets. This name, when needed, is used by dekorate to generate the descriptor associated with the targeted deployment platform.
      Specified by:
      targetPlatformName in interface EnvVarHolder
      Returns:
      the name of the targeted platform e.g. Constants.KUBERNETES

    • flavor

      @WithDefault("v4") OpenShiftConfig.OpenshiftFlavor flavor()
      The OpenShift flavor / version to use. Older versions of OpenShift have minor differences in the labels and fields they support. This option allows users to have their manifests automatically aligned to the OpenShift 'flavor' they use.

    • deploymentKind

      Optional<DeploymentResourceKind> deploymentKind()
      The kind of the deployment resource to use. Supported values are 'Deployment', 'StatefulSet', 'Job', 'CronJob' and 'DeploymentConfig'. Defaults to 'DeploymentConfig' if flavor == v3, or 'Deployment' otherwise. DeploymentConfig is deprecated as of OpenShift 4.14. See https://access.redhat.com/articles/7041372 for details.

    • replicas

      @WithDefault("1") Integer replicas()
      The number of desired pods

    • nodePort

      OptionalInt nodePort()
      The nodePort to set when serviceType is set to nodePort

    • containers

      @Deprecated Map<String,ContainerConfig> containers()
      Deprecated.
      Use the sidecars property instead
      Sidecar containers

    • route

      RouteConfig route()
      OpenShift route configuration

    • job

      JobConfig job()
      Job configuration. It's only used if and only if quarkus.openshift.deployment-kind is `Job`.

    • cronJob

      CronJobConfig cronJob()
      CronJob configuration. It's only used if and only if quarkus.openshift.deployment-kind is `CronJob`.

    • remoteDebug

      DebugConfig remoteDebug()
      Debug configuration to be set in pods.

    • externalizeInit

      @Deprecated(since="3.1", forRemoval=true) @WithDefault("true") boolean externalizeInit()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use initTasks() configuration instead
      Flag to enable init task externalization. When enabled (default), all initialization tasks created by extensions, will be externalized as Jobs. In addition, the deployment will wait for these jobs.

    • initTasks

      @ConfigDocMapKey("task-name") Map<String,InitTaskConfig> initTasks()
      Init tasks configuration.

      The init tasks are automatically generated by extensions like Flyway to perform the database migration before starting up the application.

      This property is only taken into account if `quarkus.openshift.externalize-init` is true.

    • initTaskDefaults

      InitTaskConfig initTaskDefaults()
      Default init tasks configuration.

      The init tasks are automatically generated by extensions like Flyway to perform the database migration before staring up the application.

    • deploy

      @WithDefault("false") boolean deploy()
      If set to true, Quarkus will attempt to deploy the application to the target Kubernetes cluster

    • deployStrategy

      @WithDefault("CreateOrUpdate") DeployStrategy deployStrategy()
      If deploy is enabled, it will follow this strategy to update the resources to the target Kubernetes cluster.

    • isOpenshiftBuildEnabled

      static boolean isOpenshiftBuildEnabled(ContainerImageConfig containerImageConfig, io.quarkus.deployment.Capabilities capabilities)

    • getDeploymentResourceKind

      default DeploymentResourceKind getDeploymentResourceKind(io.quarkus.deployment.Capabilities capabilities)

    • getSidecars

      @Deprecated default Map<String,ContainerConfig> getSidecars()
      Deprecated.
      Specified by:
      getSidecars in interface PlatformConfiguration