Search documentation
karat

+

K

apollo-cli entity maintenancewindowoverride create [Experimental]

This command is Experimental. To enable this command, run the apollo-cli configure command and enable V2 experimental commands.

Create maintenance window overrides for one or more entities

Opens one change request per unique Apollo entity ID to create a maintenance window override. Defaults to no-downtime; use --downtime to allow downtime.

All overrides share a start time of now and an end time of now plus --duration. Normal change request approval policies apply, so time awaiting approval consumes part of the requested interval. Entities may belong to different environments.

If submission fails, previously created change requests are printed and remaining entities are not submitted. Use --dry-run to preview all requests without creating them.

Copied!
1 apollo-cli entity maintenancewindowoverride create <aeid> [<aeid>...] [flags]

Examples

  apollo-cli entity mwo create aeid:my-env:helm-chart:my-chart --duration 2h --reason "Emergency deployment"
  apollo-cli entity mwo create aeid:my-env:helm-chart:chart-a aeid:my-env:helm-chart:chart-b --duration 30m --downtime --reason "Planned maintenance"

Flags

FlagUse
--compliance-ticketCompliance ticket ID to attach to the change request (e.g. FRCCB-1234)
--downtimeAllow downtime during the override (defaults to no-downtime)
--dry-runPrint the operations that would be performed
--durationOverride duration (e.g. 30m or 2h); must be positive and at most 3600h (150 days)
-h, --helpHelp for create
--reasonJustification for the overrides, used as the change request description

Flags inherited from parent commands

FlagUse
--apollo-client-idClient ID to use for generating Bearer Token
--apollo-client-secretClient secret to use for generating Bearer Token
--apollo-tokenBearer Token to use for authenticated endpoints
--apollo-token-providerSpecifies how the Bearer Token used for authenticated Apollo endpoint calls is provided. Valid values are "auto", "static", "service-user", or "sso" (default "auto"). If "auto" is specified, the mode is picked from what is configured: "static" if "apollo-token" is set, "service-user" if "apollo-client-id" and "apollo-client-secret" are both set, otherwise "sso" (interactive browser login). Errors if both a bearer token AND (client id OR client secret) are set. If "static" is specified, the token provided by "apollo-token" is used. If "service-user" is specified, "apollo-client-id" and "apollo-client-secret" are used to generate a token from Multipass. If "sso" is specified, an interactive browser-based SSO login against Multipass is used (supports hardware keys like YubiKey); the resulting token is cached per profile and refreshed silently. The login flow is triggered automatically the first time a command needs a token and no valid cached token exists.
--apollo-urlBase URL for Apollo that is used to derive the API endpoints
--debugEnable debug level logging
-e, --environmentEnvironment ID (including suffix) to use for environment-scoped commands
--http-timeoutTimeout in minutes for all apollo requests
-k, --insecure-skip-verifySkip verification of server certificate
-o, --outputOutput format (json,yaml,pretty)
--profileUse a specific profile from your configuration file
--quietDo not print log output to stderr
--space-idSpace ID to use for certain space-scoped commands
--sso-callback-portLocal loopback port for the SSO OAuth callback; 0 selects an available ephemeral port

See also