• Apollo
    • Search documentation
    karat

    +

    K

    ReferenceApollo CLIapollo-cli product promotion set [Experimental]

    apollo-cli product promotion set [Experimental]

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

    Set or update the promotion pipeline from a configuration file

    Set or update the promotion pipeline configuration for a product from a YAML file.

    The configuration file defines the promotion pipeline stages, including:

    • Source and target release channels for each stage
    • Stage type (zeroCanary or dynamic)
    • Promotion conditions and thresholds

    MODES: Single product: apollo-cli product promotion set --file pipeline.yaml Bulk (environment): apollo-cli product promotion set --environment --file pipeline.yaml

    Example configuration file (promotion-pipeline.yaml): stages: - sourceReleaseChannel: BETA targetReleaseChannel: RELEASE type: zeroCanary zeroCanary: soakTimeInMinutes: 1440 productLabelConditions: - labelId: "security.palantir.build/approved" possibleLabelValues: ["true"] - sourceReleaseChannel: CANARY targetReleaseChannel: BETA type: dynamic dynamicConfig: entityFilters: - type: environmentLabel labelId: "env.palantir.build/tier" possibleLabelValues: ["production"] promotionConditions: - type: minHealthy soakTimeInMinutes: 60 minHealthyThreshold: percentage: 95.0

    Example:

    Set promotion pipeline from config file (uses configured default space-id)

    apollo-cli product promotion set com.example --file promotion-pipeline.yaml

    Preview changes without applying (dry run)

    apollo-cli product promotion set com.example --file promotion-pipeline.yaml --dry-run

    Set with specific space ID

    apollo-cli product promotion set com.example --file promotion-pipeline.yaml --space-id my-space

    Set pipeline for all products in an environment

    apollo-cli product promotion set --environment my-env-id --file promotion-pipeline.yaml

    Set for all products without confirmation prompt

    apollo-cli product promotion set --environment my-env-id --file promotion-pipeline.yaml --override

    Copied!
    1
apollo-cli product promotion set [product-id] [flags]

    Flags

    FlagUse
    --dry-runPrint the operations that would be performed
    -e, --environmentEnvironment
    -f, --fileA single input file
    -h, --helpHelp for set
    --overrideOverride conflicts without prompting
    --space-idSpace ID

    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", or "service-user" (default "auto"). If "auto" is specified, will use either the Bearer Token provided by "apollo-token" or a Bearer Token obtained by using "apollo-client-id" and "apollo-client-secret" to generate a token from Multipass depending on which values are set (but will error if both values 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.
    --apollo-urlBase URL for Apollo that is used to derive the API endpoints
    --debugEnable debug level logging
    --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

    See also