Fork me on GitHub
Built by Maven

createk8syaml:deploy

Full name:

io.github.parj:createk8syaml-maven-plugin:0.0.6-SNAPSHOT:deploy

Description:

Deploys deployment, service and ingress file to a Kubernetes cluster. By default to connect to the cluster, the app tries to pick up ~/.kube/config to be able to authenticate. The location can be overriden by providing a configuration kubeconfig or by setting an environment variable KUBECONFIG. If the KUBECONFIG environment variable, this will override any setting provided via pom.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: deploy.

Optional Parameters

Name Type Since Description
<checkConnection> boolean - Choose whether or not to check connection to cluster. Defaults to true by default
Default value is: true.
User property is: checkConnection.
<context> String - The kubernetes context to use to connect to the server
User property is: context.
<deployDeployment> boolean - Choose whether to deploy a deployment object. Defaults to true
Default value is: true.
User property is: deployDeployment.
<deployIngress> boolean - Choose whether to deploy a ingress object. Defaults to false
Default value is: false.
User property is: deployIngress.
<deployService> boolean - Choose whether to deploy a service object. Defaults to false
Default value is: false.
User property is: deployService.
<filesLocation> String - The directory containing the kubernetes files. Defaults to project.build.directory. For maven, this is usually the target folder
Default value is: ${project.build.directory}.
User property is: filesLocation.
<kubeconfig> String - The location of the kube config file. Defaults to $HOME/.kube/config
User property is: kubeconfig.

Parameter Details

<checkConnection>

Choose whether or not to check connection to cluster. Defaults to true by default
  • Type: boolean
  • Required: No
  • User Property: checkConnection
  • Default: true

<context>

The kubernetes context to use to connect to the server
  • Type: java.lang.String
  • Required: No
  • User Property: context

<deployDeployment>

Choose whether to deploy a deployment object. Defaults to true
  • Type: boolean
  • Required: No
  • User Property: deployDeployment
  • Default: true

<deployIngress>

Choose whether to deploy a ingress object. Defaults to false
  • Type: boolean
  • Required: No
  • User Property: deployIngress
  • Default: false

<deployService>

Choose whether to deploy a service object. Defaults to false
  • Type: boolean
  • Required: No
  • User Property: deployService
  • Default: false

<filesLocation>

The directory containing the kubernetes files. Defaults to project.build.directory. For maven, this is usually the target folder
  • Type: java.lang.String
  • Required: No
  • User Property: filesLocation
  • Default: ${project.build.directory}

<kubeconfig>

The location of the kube config file. Defaults to $HOME/.kube/config
  • Type: java.lang.String
  • Required: No
  • User Property: kubeconfig