cub filter create

Create a new filter or bulk create filters

Synopsis

Create a new filter or bulk create multiple filters by cloning existing ones.

SINGLE FILTER CREATION:

Create a new filter to define entity filter expressions.

From Types: the entity type the filter selects, such as

Unit: Filter units
Space: Filter spaces
Component: Filter components
Revision: Filter revisions
Trigger: Filter triggers
Target: Filter targets
ChangeSet, ChangeOrder: Filter change sets and change orders
BridgeWorker: Filter workers

Most other entity types are accepted too, named as in the API, such as Link, Tag, Invocation, Mutation, ReviewComment, Resource, ServiceAccount and Release.

Examples:

  # Create a filter for Units with specific labels
  cub filter create --space my-space -o json unit-filter Unit --where-field "Labels.Environment = 'production'"

  # Create a filter for Units with specific resource type
  cub filter create --space my-space -o json deployment-filter Unit --resource-type "apps/v1/Deployment"

  # Create a filter for Units with data filters
  cub filter create --space my-space -o json replicas-filter Unit --where-data "spec.replicas > 2"

  # Create a filter for Spaces with specific criteria
  cub filter create --space my-space -o json dev-spaces Space --where-field "Labels.Environment = 'dev'"

  # Create a filter with from-space for filtering within a specific space
  cub filter create --space my-space -o json cross-space-filter Unit --from-space other-space --where-field "DisplayName LIKE 'app-%'"

BULK FILTER CREATION:

When no positional arguments are provided, bulk create mode is activated. This mode clones existing filters based on filters and creates multiple new filters with optional modifications.

Bulk Create Examples:

  # Clone all filters matching a pattern with name prefixes
  cub filter create --where "From = 'Unit'" --name-prefix dev-,staging- --dest-space dev-space

  # Clone specific filters to multiple spaces
  cub filter create --filter-entity my-filter --dest-space dev-space,staging-space

  # Clone filters using a where expression for destination spaces
  cub filter create --where "From = 'Space'" --where-space "Labels.Environment IN ('dev', 'staging')"

  # Clone filters with modifications via JSON patch
  echo '{"From": "Unit"}' | cub filter create --where "From = 'Space'" --name-prefix unit- --from-stdin

cub filter create [<slug> <from> [--where-field <where>] [--where-data <where-data>] [--resource-type <resource-type>] [--from-space <from-space>]] [flags]

Options

      --allow-exists                  Allow creation of resources that already exist
      --annotation strings            annotations in key=value format; can separate by commas and/or use multiple instances of the flag
      --delete-gate strings           delete gates in key[=true] format; can separate by commas and/or use multiple instances of the flag
      --dest-space strings            destination spaces for bulk create (can be repeated or comma-separated)
      --display-name string           friendly name for the entity, which need not be unique or URL-safe; an entity without one is shown by its slug
      --dry-run                       report what the command would write, and write nothing
      --filename string               Read the ConfigHub entity's fields, as YAML or JSON, from file, URL (https://), or stdin (-), as --from-stdin does; mutually exclusive with --from-stdin
      --filter string                 Filter entity to apply to the list. Specify as 'space/filter' for cross-space filters or just 'filter' for current space. Supports both slugs and UUIDs. The filter will be combined with any --where clause using AND logic. Examples: "production-filters/security-check", "my-filter-uuid", "validation-rules"
      --filter-entity strings         target specific filters by slug or UUID for bulk create (can be repeated or comma-separated)
      --filter-space string           filter entity containing WHERE expression to select destination spaces for bulk create (slug or UUID)
      --filter-unit string            filter, by slug or UUID, over Units selecting those to create from, with --from-backing-units
      --from-backing-units            create a Filter from each ConfigHub/YAML Unit --where-unit, --filter-unit and --space select that describes one, in the Unit's space, with the Unit as its backing Unit
      --from-space string             space to filter within (slug or UUID, only relevant for spaced entity types)
      --from-stdin                    Read the ConfigHub entity's fields, as YAML or JSON, from stdin; merged with command arguments on create, and merged with command arguments and existing entity on update. A field the entity does not have, or one only the server sets, is refused; cub <entity> explain lists the fields
  -h, --help                          help for create
      --hidden-reason string          hide the entity, giving the reason as a name such as Archived: lists and bulk operations leave it out unless --include-hidden names the reason (use '-' to clear, which shows the entity again)
      --include-hidden string[="*"]   Also select hidden entities, to list or to act on: those hidden for the given HiddenReasons, comma-separated, as in --include-hidden=BackingUnit, or for any reason when given no value or "*". ConfigHub/YAML Units, which hold the configuration of other entities, are hidden with the reason BackingUnit. A --where naming entities by Slug or ID selects them whether hidden or not
      --include-hidden-field string   HiddenReasons, comma-separated, or "*" for any: where the filter is applied to a list or a bulk operation, it also selects entities hidden for those reasons
      --label strings                 labels in key=value format; can separate by commas and/or use multiple instances of the flag
      --name-pattern string           a pattern string for name generation of clones, prefix 'template:' to use a Go template with .SourceEntitySlug to access the original Filter and .Labels to access variant labels, example: 'template:{{.SourceEntitySlug}}-{{.Labels.env}}'
      --name-prefix strings           name prefixes for bulk create (can be repeated or comma-separated)
  -o, --output string                 Output format. One of: json, yaml, name, wide, mutations, jq=<expr>, yq=<expr>, custom-columns=<spec>
      --patch-existing                with --from-backing-units, patch a Filter a selected Unit already backs with what the Unit holds that it has not taken yet, rather than report that the Unit backs it
      --permission strings            permission in format Action:UserIDOrUsername, Action:group:GroupSlugOrID for a group you belong to, or Action:serviceaccount:ServiceAccountSlugOrID (e.g., Manage:user@example.com, View:group:platform, View:serviceaccount:deploy-bot, can be repeated)
      --quiet                         No default output.
      --resource-type string          resource type to match (e.g., apps/v1/Deployment, valid only for Units)
      --set stringArray               set a field of the Filter by its path, as <path>=<value> (repeatable). A path is field names separated by dots; a list element is addressed as ?<key>=<value> or by position, as in Stages.?Name=prod.WhereSpace, and is added if it is not there. A list of plain values separates them with ';'; an object or a list of objects is given as YAML or JSON. A reference is given as it is elsewhere, by slug, <space>/<slug> or ID. With --patch, only a path with no list element in it
      --unset stringArray             clear a field of the Filter by its path, or remove the list element the path ends at (repeatable)
      --variant-labels strings        labels for bulk create in the format of key1=value1|value2,key2=value1|value2|value3
      --verbose                       Detailed output, additive with default output
      --where string                  Filter expression using SQL-inspired syntax. Supports conjunctions with AND. String operators: =, !=, <, >, <=, >=, LIKE, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*. Pattern matching with LIKE/ILIKE uses % and _ wildcards. Regex operators (~, ~*, !~, !~*) support POSIX regular expressions. A related entity is referenced by prefix, as in "UpstreamUnit.Slug = 'base'"; when the reference names a list, a * segment matches any element, as in "FromLink.*.Slug = 'upgrade-app'". Examples: "Slug LIKE 'app-%'", "DisplayName ILIKE '%backend%'", "Slug ~ '^[a-z]+-[0-9]+$'"
      --where-data string             where filter expression for configuration data (valid only for Units)
      --where-field string            where expression for the filter entity
      --where-space string            where expression to select destination spaces for bulk create
      --where-unit string             where expression over Units selecting those to create from, with --from-backing-units
      --with-backing-units            give each Filter the bulk operation writes a backing Unit if it has none: a ConfigHub/YAML Unit holding its configuration, kept in step with it

Options inherited from parent commands

      --component string   the Component of --variant, when that names the variant alone; --variant <component>/<variant> says the same in one flag
      --context string     The context to use for this command
      --debug              Debug output
      --space string       space to operate in, by slug or UUID. Omitted, a list or bulk operation spans the organization and a single entity is named as <space>/<slug>; "*" means the same as omitting it
      --variant string     variant to operate in, as <component>/<variant>, or as <variant> with --component: the space naming that Component whose Variant label is <variant>. The same scope as --space, named by what it is rather than by the space's slug; the two cannot be combined

cub filter create