Skip to content

Latest commit

 

History

History
297 lines (202 loc) · 6.99 KB

README.adoc

File metadata and controls

297 lines (202 loc) · 6.99 KB

Requirements

The following requirements are needed by this module:

Modules

The following Modules are called:

Source: ../nodeport/

Version:

Required Inputs

The following input variables are required:

Description: Name given to the cluster. Value used for the ingress' URL of the application.

Type: string

Description: Base domain of the cluster. Value used for the ingress' URL of the application.

Type: string

Description: Namespace used by Argo CD where the Application and AppProject resources should be created.

Type: string

Optional Inputs

The following input variables are optional (have default values):

Description: Name of the Argo CD AppProject where the Application should be created. If not set, the Application will be created in a new AppProject only for this Application.

Type: string

Default: null

Description: Labels to attach to the Argo CD Application resource.

Type: map(string)

Default: {}

Description: Destination cluster where the application should be deployed.

Type: string

Default: "in-cluster"

Description: Override of target revision of the application chart.

Type: string

Default: "v4.0.0"

Description: Namespace where the applications’s Kubernetes resources should be created. Namespace will be created in case it doesn’t exist.

Type: string

Default: "traefik"

Description: Number of Traefik pods to be deployed.

Type: string

Default: "2"

Description: Enable Prometheus ServiceMonitor in the Helm chart.

Type: bool

Default: true

Description: Helm chart value overrides. They should be passed as a list of HCL structures.

Type: any

Default: []

Description: Automated sync options for the Argo CD Application resource.

Type:

object({
    allow_empty = optional(bool)
    prune       = optional(bool)
    self_heal   = optional(bool)
  })

Default:

{
  "allow_empty": false,
  "prune": true,
  "self_heal": true
}

Description: IDs of the other modules on which this module depends on.

Type: map(string)

Default: {}

Description: Enable HTTP to HTTPS redirection on all ingresses.

Type: bool

Default: true

Outputs

The following outputs are exported:

Description: ID to pass other modules in order to refer to this module as a dependency. It takes the ID that comes from the main module and passes it along to the code that called this variant in the first place. = Requirements

Name Version

>= 5

>= 3

>= 1

Modules

Name Source Version

Inputs

Name Description Type Default Required

Name given to the cluster. Value used for the ingress' URL of the application.

string

n/a

yes

Base domain of the cluster. Value used for the ingress' URL of the application.

string

n/a

yes

Namespace used by Argo CD where the Application and AppProject resources should be created.

string

n/a

yes

Name of the Argo CD AppProject where the Application should be created. If not set, the Application will be created in a new AppProject only for this Application.

string

null

no

Labels to attach to the Argo CD Application resource.

map(string)

{}

no

Destination cluster where the application should be deployed.

string

"in-cluster"

no

Override of target revision of the application chart.

string

"v4.0.0"

no

Namespace where the applications’s Kubernetes resources should be created. Namespace will be created in case it doesn’t exist.

string

"traefik"

no

Number of Traefik pods to be deployed.

string

"2"

no

Enable Prometheus ServiceMonitor in the Helm chart.

bool

true

no

Helm chart value overrides. They should be passed as a list of HCL structures.

any

[]

no

Automated sync options for the Argo CD Application resource.

object({
    allow_empty = optional(bool)
    prune       = optional(bool)
    self_heal   = optional(bool)
  })
{
  "allow_empty": false,
  "prune": true,
  "self_heal": true
}

no

IDs of the other modules on which this module depends on.

map(string)

{}

no

Enable HTTP to HTTPS redirection on all ingresses.

bool

true

no

Outputs

Name Description

id

ID to pass other modules in order to refer to this module as a dependency. It takes the ID that comes from the main module and passes it along to the code that called this variant in the first place.