CLI configuration

It is possible to configure different aspects of the OpenStackClient (not the clouds connection credentials) using the configuration file ($XDG_CONFIG_DIR/osc/config.yaml). This enables user to configurate which columns should be returned when no corresponding run time arguments on a resource base.

views:
  compute.server:
    # Listing compute servers will only return ID, NAME and IMAGE columns unless `-o wide` or
    `-f XXX` parameters are being passed
    default_fields: [id, name, image]
    fields:
      - name: id
        width: 38 # Set column width at fixed 38 chars
        # min_width: 1 - Set minimal column width
        # max_width: 1 - Set maximal column width
  dns.zone/recordset:
    # DNS zone recordsets are listed in the wide mode by default.
    wide: true
    fields:
      - name: status
        max_width: 15  # status column can be maximum 15 chars wide

The key of the views map is a resource key shared among all openstack_rusttools and is built in the following form: <SERVICE-TYPE>.<RESOURCE_NAME>[/<SUBRESOURCE_NAME>] where <RESOURCE_NAME>[/<SUBRESOURCE_NAME> is a url based naming (for designate /zone/<ID>/recordset/<RS_ID> would be names as zone.recordset and /volumes/{volume_id}/metadatawould become volume.metadata. Please consult Codegenerator metadata for known resource keys.

Resource view options

• default_fields (list[str])

  A list of fields to be displayed by default (in not wide mode). If not specified, only certain fields determined internally are displayed. Output columns are sorted in the order given in the list.

• wide (bool)

  If set to true, display all fields. If set to false, display only the default_fields.

• fields (list[obj])

  A list of column configuration. Consists of:

  • name (str) - field name (resource attribute name)

  • width (int) - column width in characters

  • min_width (int) - minimum column width in characters

  • max_width (int) - maximum column width in characters

  • json_pointer (str) - JSON pointer to the extract from the resource field. This is only applied in the list and not wide mode.

Hints

osc allows showing hints after the command output.

• enable_hints (bool) - enable or disable hints. Is on by default.

• hints (list) - list of general hints that are not command specific.

• command_hints (dict) - dictionary of command specific hints. The key is the resource name. The value is a dictionary with the command name and the value is a list of hints.

All global hints are combined with the command specific hints and then a random hint is being selected to be shown.

Hints are not shows always. They are hidden between a random flag gate.