Skip to content

Latest commit

 

History

History
134 lines (92 loc) · 7.18 KB

index.md

File metadata and controls

134 lines (92 loc) · 7.18 KB

Packages

  • getambassador.io/v2

    Package v2 contains API Schema definitions for the getambassador v2 API group

Resource Types

AmbInsCondition

(Appears on:AmbassadorInstallationStatus)

AmbInsCondition defines an Ambassador installation condition, as well as the last time there was a transition to this condition..

AmbInsConditionReason(string alias)

(Appears on:AmbInsCondition)

AmbInsConditionStatus(string alias)

(Appears on:AmbInsCondition)

AmbInsConditionType(string alias)

(Appears on:AmbInsCondition)

AmbassadorInstallation

AmbassadorInstallation is the Schema for the ambassadorinstallations API

AmbassadorInstallationSpec

(Appears on:AmbassadorInstallation)

AmbassadorInstallationSpec defines the desired state of AmbassadorInstallation

  • version - string

    We are using SemVer for the version number and it can be specified with any level of precision and can optionally end in *. These are interpreted as:

    • 1.0 = exactly version 1.0
    • 1.1 = exactly version 1.1
    • 1.1.* = version 1.1 and any bug fix versions 1.1.1, 1.1.2, 1.1.3, etc.
    • 2.* = version 2.0 and any incremental and bug fix versions 2.0, 2.0.1, 2.0.2, 2.1, 2.2, 2.2.1, etc.
    • * = all versions.
    • 3.0-ea = version 3.0-ea1 and any subsequent EA releases on 3.0. Also selects the final 3.0 once the final GA version is released.
    • 4.*-ea = version 4.0-ea1 and any subsequent EA release on 4.0. Also selects the final GA 4.0. Also selects any incremental and bug fix versions 4.* and 4.*.*. Also selects the most recent 4.* EA release i.e., if 4.0.5 is the last GA version and there is a 4.1-EA3, then this selects 4.1-EA3 over the 4.0.5 GA.

    You can find the reference docs about the SemVer syntax accepted here.

  • baseImage - string

    An (optional) image to use instead of the image specified in the Helm chart.

  • helmRepo - string

    An (optional) Helm repository.

  • logLevel - string

    An (optional) log level: debug, info…

  • updateWindow - string

    updateWindow is an optional item that will control when the updates can take place. This is used to force system updates to happen late at night if that’s what the sysadmins want.

    • There can be any number of updateWindow entries (separated by commas).
    • Never turns off automatic updates even if there are other entries in the comma-separated list. Never is used by sysadmins to disable all updates during blackout periods by doing a kubectl apply or using our Edge Policy Console to set this.
    • Each updateWindow is in crontab format (see https://crontab.guru/) Some examples of updateWindows are:
      • * 0-6 * * * SUN: every Sunday, from 0am to 6am
      • * 5 1 * * *: every first day of the month, at 5am
    • The Operator cannot guarantee minute time granularity, so specifying a minute in the crontab expression can lead to some updates happening sooner/later than expected.

  • installOSS - bool

    Installs Ambassador OSS instead of AES. Default is false which means it installs AES by default. TODO:

    1. AES/AOSS is not installed and the user installs using installOSS: true, then we straightaway install AOSS.
    2. AOSS is installed via operator and the user sets installOSS: false, then we perform the migration as detailed here - https://www.getambassador.io/docs/latest/topics/install/upgrade-to-edge-stack/
    3. AES is installed and the user sets installOSS: true, then we point users to the docs which gives them pointers on how to do that themselves.

AmbassadorInstallationStatus

(Appears on:AmbassadorInstallation)

AmbassadorInstallationStatus defines the observed state of AmbassadorInstallation

AmbassadorRelease

(Appears on:AmbassadorInstallationStatus)

AmbassadorRelease defines a release of an Ambassador Helm chart

  • name - string

  • version - string

  • appVersion - string

  • manifest - string

  • flavor - string