Documentation
¶
Index ¶
Constants ¶
const ( Infrastructure kind = "infrastructure" Service kind = "service" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Cache ¶
type Cache struct {
// contains filtered or unexported fields
}
Cache represents the dumb pipes connecting our business logic across different boundary conditions by providing critical information required to make the entire operator chain work as expected. The operator's worker handler is executed constantly in an interval, but the real work may only be done if the cached information about the specific release artifacts provided deeper down the stack is sufficient. E.g. an empty cache result may cause some business logic to be skipped temporarily, or cause the reconciliation loop to be cancelled entirely.
func (*Cache) Infrastructure ¶ added in v0.1.1
func (*Cache) Previews ¶ added in v0.4.0
Previews returns all cached service release artifacts that are defined as preview deployments.
type Config ¶ added in v0.1.1
type Config struct {
// Frc is to forcefully trigger an infrastructure deployment, regardless of
// any detectable state drift. This option should be used with caution. E.g.
// the command "kayron daemon" should never allow to apply this trigger flag
// within Kayron's normal reconciliation loop.
Frc bool
Log logger.Interface
}
type Object ¶ added in v0.1.1
type Object struct {
Artifact artifact.Struct
Release release.Struct
// contains filtered or unexported fields
}
Object combines the associated artifact and release information in one addressable cache object. The artifact information are written and the release information are read throughout the reconciliation loops.
func (Object) Domain ¶ added in v0.4.0
Domain returns the hash based testing domain for preview deployments, or an empty string for any other main release and non-testing environment.
1d0fd508.lite.testing.splits.org
func (Object) Drift ¶ added in v0.4.3
Drift tries to detect a single valid state drift, in order to allow allow the operator chain to execute. Our current policy requires the following conditions to be true for a valid state drift using the ready flag. If the ready flag is false, then only the first three conditions are being evaluated. That way we can differentiate between ready and waiting state drift. Note that the set of waiting release artifacts may also contain ready release artifacts.
the desired deployment must not be suspended
the current and desired state must not be equal
the desired state must not be empty
the container image for the desired state must be pushed
func (Object) Parameter ¶ added in v0.1.2
Parameter returns the CloudFormation stack parameter key for this release artifact. The parameter keys generated here have to be supported in the CloudFormation template being deployed, e.g. InfrastructureVersion, SpectaVersion.
func (Object) Preview ¶ added in v0.4.1
Preview returns whether this release artifact is for an automatically injected preview deployment. The determining factor here is whether a preview hash exists.
func (Object) Version ¶ added in v0.2.1
Version returns the desired state of this artifact's release version if the following two conditions are true. Failed artifact conditions and deployment suspensions will then yield the artifact version of the scheduler's current state.
the artifact condition must be true
the deployment strategy must not be suspended
E.g. we may observe the new version of a service v0.5.0, for which there does no docker image exist yet. In this case we defer to the old version v0.4.0, which is currently deployed. Once the docker image for v0.5.0 has been confirmed inside of the underlying container registry, we will yield the new desired version.
Source Files