Class AcmeOptions

Describes CertManager related options.

Inheritance

object

AcmeOptions

Namespace: Neon.Kube.ClusterDef

Assembly: Neon.Kube.dll

Syntax

public class AcmeOptions

Constructors

AcmeOptions()

Default constructor.

Declaration

public AcmeOptions()

Properties

CertificateDuration

Specifies the maximum lifespan for internal cluster TLS certificates as a GOLANG formatted string.
This defaults to 504h (21 days). See Parse(string) for details about the timespan format.

Declaration

[JsonProperty(PropertyName = "CertificateDuration", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "certificateDuration", ApplyNamingConventions = false)]
public string CertificateDuration { get; set; }

Property Value

Type	Description
string

CertificateRenewBefore

Specifies the time to wait before attempting to renew for internal cluster TLS certificates. This must be less than CertificateDuration and defaults to 336h (14 days). See Parse(string) for details about the timespan format.

Declaration

[JsonProperty(PropertyName = "CertificateRenewBefore", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "certificateRenewBefore", ApplyNamingConventions = false)]
public string CertificateRenewBefore { get; set; }

Property Value

Type	Description
string

Issuer

The specification of an Issuer. This includes any configuration required for the issuer.

Declaration

[JsonProperty(PropertyName = "Issuer", Required = Required.Default, DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
[YamlMember(Alias = "issuer", ApplyNamingConventions = false)]
public AcmeIssuer Issuer { get; set; }

Property Value

Type	Description
AcmeIssuer

Methods

Validate(ClusterDefinition)

Validates the options and also ensures that all null properties are initialized to their default values.

Declaration

public void Validate(ClusterDefinition clusterDefinition)

Parameters

Type	Name	Description
ClusterDefinition	clusterDefinition	The cluster definition.

Exceptions

Type	Condition
ClusterDefinitionException	Thrown if the definition is not valid.