coriolis-web/config.ts

import type { Config } from "@src/@types/Config";

const conf: Config = {
  // The list of pages which will not appear in the navigation menu
  // Remove or comment to enable them
  disabledPages: [
    "planning",
    // Enabling users and projects page by default
    // 'users',
    // 'projects',
    // 'bare-metal-servers',
  ],

  // Whether to show the user domain name input when logging in
  showUserDomainInput: false,

  // The default user domain name used for logging in
  defaultUserDomain: "default",

  // The name of the admin role, used for checking
  // if a user is allowed to do certain admin operations
  adminRoleName: "admin",

  // Shows the 'Use Current User/Project/Domain for Authentification' switch
  // when creating a new openstack endpoint
  showOpenstackCurrentUserSwitch: false,

  // Whether to use Barbican secrets when creating a new endpoint
  useBarbicanSecrets: true,

  // The timeout between polling requests
  requestPollTimeout: 5000,

  // The timeout for an inactive user session (in ms). Set 0 to disable.
  inactiveSessionTimeout: 0,

  // - Specifies the `limit` for each provider when listing all its VMs for pagination.
  // - If the provider is not in this list, the 'default' value will be used.
  // - If the `default` value is lower than the number of instances that
  // fit into a page, the latter number will be used.
  // - `Infinity` value means no `limit` will be used, i.e. all VMs will be listed.
  instancesListBackgroundLoading: {
    default: 100,
    ovm: Infinity,
    "hyper-v": Infinity,
  },

  /**
   * The name of the Coriolis Bare Metal Hub enpoint used for doing Coriolis Bare Metal server operations.
   */
  bareMetalEndpointName: "appliance-metal-hub",

  /**
   * The list of providers for which and extra source or destination options API call will be made.
   * The API call will be made only if all the required fields have values.
   * If `requiredValues` is provided, the field specified there needs to have a
   * certain value (specified in values)
   * in order to make the options API call.
   * If `relistFields` is provided, the options call will be made if any of the relist fields are changed.
   */
  extraOptionsApiCalls: [
    {
      name: "openstack",
      types: ["source"],
      requiredFields: ["replica_export_mechanism"],
      requiredValues: [
        {
          field: "replica_export_mechanism",
          values: ["swift_backups", "ceph_backups", "coriolis_backups"],
        },
      ],
    },
    {
      name: "openstack",
      types: ["destination"],
      requiredFields: ["list_all_destination_networks"],
    },
    {
      name: "vhi",
      types: ["destination"],
      requiredFields: ["list_all_destination_networks"],
    },
    {
      name: "vhi",
      types: ["source"],
      requiredFields: ["replica_export_mechanism"],
      requiredValues: [
        {
          field: "replica_export_mechanism",
          values: ["swift_backups", "ceph_backups", "coriolis_backups"],
        },
      ],
    },
    {
      name: "aws",
      types: ["source", "destination"],
      requiredFields: ["region"],
    },
    {
      name: "azure",
      types: ["source", "destination"],
      requiredFields: ["location", "resource_group"],
    },
    {
      name: "oci",
      types: ["destination"],
      requiredFields: ["compartment", "availability_domain", "vcn_compartment"],
      relistFields: ["migr_image_map", "migr_image"],
    },
    {
      name: "opca",
      types: ["destination"],
      requiredFields: ["compartment", "availability_domain", "vcn_compartment"],
      relistFields: ["migr_image_map", "migr_image"],
    },
    {
      name: "o3c",
      types: ["destination"],
      requiredFields: ["compartment", "availability_domain", "vcn_compartment"],
      relistFields: ["migr_image_map", "migr_image"],
    },
    {
      name: "vmware_vsphere",
      types: ["destination"],
      requiredFields: ["import_datacenter"],
      relistFields: ["import_cluster", "migr_minion_cluster"],
    },
    {
      name: "proxmox",
      types: ["destination"],
      requiredFields: ["import_node"],
      relistFields: ["linux_template", "windows_template"],
    },
    {
      name: "olvm",
      types: ["destination"],
      requiredFields: ["cluster"],
    },
    {
      name: "rhev",
      types: ["destination"],
      requiredFields: ["cluster"],
    },
  ],

  /*
  Lower number means that the provider will appear sooner in the list.
  Equal number means alphabetical order within the same group number.
  If the provider is not in the list, it will appear later and alphabetically sorted
  with all the other providers not in the list.
  */
  providerSortPriority: {
    aws: 1,
    openstack: 1,
    vhi: 2,
    vmware_vsphere: 1,
    azure: 2,
    "hyper-v": 2,
    kubevirt: 2,
    harvester: 2,
    scvmm: 2,
    oci: 3,
    opc: 3,
    oracle_vm: 3,
    olvm: 3,
    opca: 3,
    o3c: 3,
    proxmox: 3,
    rhev: 3,
    metal: 4,
    lxd: 4,
    libvirt: 4,
  },

  providerNames: {
    aws: "AWS",
    openstack: "OpenStack",
    vhi: "VHI",
    vmware_vsphere: "VMware",
    azure: "Azure",
    "hyper-v": "Hyper-V",
    kubevirt: "KubeVirt",
    harvester: "SUSE Virtualization",
    scvmm: "SCVMM",
    oci: "OCI",
    opca: "Oracle Private Cloud Appliance",
    o3c: "Oracle Cloud Compute@Customer",
    opc: "Oracle Cloud",
    oracle_vm: "Oracle VM",
    olvm: "OLVM",
    metal: "Bare Metal",
    rhev: "Red Hat",
    lxd: "LXD",
    proxmox: "Proxmox VE",
    libvirt: "Libvirt",
  },

  // The list of providers for which to disable setting the 'Execute Now Options' field
  providersDisabledExecuteOptions: ["metal"],

  // The list of execution option fields to disable for the providers in 'providersDisabledExecuteOptions'
  providersExecuteOptionsDisabledFields: ["shutdown_instances"],

  // The list of the users to hide in the UI
  hiddenUsers: ["barbican", "coriolis"],

  // The list of user roles to hide in the UI
  hiddenUserRoles: [
    "audit",
    "creator",
    "observer",
    "service",
    "key-manager:service-admin",
  ],

  // By default, if a field name contains `password` in it (ex.: `user_password`),
  // it will be rendered as a password input
  // If the field doesn't contain `password` in its name, the following list will be used instead
  passwordFields: [
    "private_key_passphrase",
    "secret_access_key",
    "client_secret",
  ],

  // The number of items per page applicable to default lists:
  // transfers, deployments, endpoints, users etc.
  defaultListItemsPerPage: 25,

  maxMinionPoolEventsPerPage: 50,

  servicesUrls: {
    keystone: "{BASE_URL}/identity",
    barbican: "{BASE_URL}/barbican",
    coriolis: "{BASE_URL}/coriolis",
    coriolisLogs: "{BASE_URL}/logs",
    coriolisLogStreamBaseUrl: "{BASE_URL}",
    coriolisLicensing: "{BASE_URL}/licensing",
    metalhub: "{BASE_URL}/metal-hub",
    cloudbaseEmailEndpoint: "http://localhost:3334",
  },
};

export const config = conf;