Skip to content

Ordering and provisioning

From a new organization to a running project: registration, the order, the approvals, provisioning and the e-mails sent on the way.

flowchart TB
  R[Register the organization] --> RA([Registration approved])
  RA --> O[Order a project]
  O --> AP([Project approved])
  AP --> P[Provisioning starts by itself]
  P --> D[Deployment on the platform]
  D --> E[E-mails: access details,<br/>organization admins,<br/>then the platform users]
  E --> W[The project works]

Registering a new organization

On the organizations' portal anybody can register an organization. They give the organization's legal name, country and tax ID, optionally its address and website (without a scheme it is taken as https), and their own full name, e-mail, mobile number and city; they become its organization admin. The form offers the portal's home country first. The tax ID follows the country: in Kazakhstan the IIN or BIN (12 digits with a check digit; a number given without its kind is checked against the kind it looks like, so one that is neither a valid IIN nor a valid BIN is refused at once), in the United Arab Emirates the TRN (15 digits) or the trade licence (registration) number from the company's licensing authority — an emirate's economic department or a free zone: 3–20 letters, digits and dashes, as written (for example CN-1234567) — elsewhere the country's tax or registration number (3 to 32 letters and digits). The country, the kind of tax ID, the tax ID and the legal name are never changed afterwards; the address and website can be changed at any time. The website is optional; when it is given, it is kept with the organization. The city is typed in; the mobile number is written in international format, starting with "+". They confirm the e-mail from the link the portal sends, and that sends the request. Nobody of the organization signs in until it is approved (the sign-in page says the registration waits).

  1. The resource manager approves first and assigns the organization's platform users: the resource manager and the support engineer are required, the sales rep is required for cloud organizations, the key account manager is optional (cloud organizations only); the type (cloud/corporate) can be corrected here.
  2. When sales rep approval is on in Settings → Customer → Approvals, the organization's sales rep approves too (cloud organizations). A person holding both roles approves once.
  3. Then the organization admin gets an e-mail: the organization is registered, they can sign in and order resources.

A refused registration is removed: the person registering is told with the reason, the organization and its users are deleted (the log keeps the record). A tax ID already registered in that country becomes a request to join that organization, decided by its admins. Organizations made by staff, or registered from a staff invitation, need no approval.

Every user has a city, the person registering included. The portal checks every registration and marks the suspicious ones for the staff; a request whose e-mail is not confirmed within 48 hours is deleted. The life of a registration request is drawn on Approvals.

sequenceDiagram
    actor P as Person registering
    participant Portal
    actor RM as Resource manager
    actor SR as Sales rep
    P->>Portal: legal name, country, tax ID, address and website (optional), full name, e-mail, mobile, city
    Portal->>P: e-mail: confirm your address
    P->>Portal: confirms within 48 hours (the request is sent)
    Portal->>RM: e-mail: new organization waiting for approval
    RM->>Portal: approves, assigns resource manager, support engineer, sales rep (KAM optional)
    alt sales rep approval on (cloud organization)
        Portal->>SR: e-mail: waiting for your approval
        SR->>Portal: approves
    end
    Portal->>P: e-mail: registered, sign in and order resources
    Note over P,Portal: refused at any step: the person is told with the reason, nothing is kept but the log

Ordering a project

An organization admin orders a project on the organizations' portal: Projects → Order a project. A resource manager or a super admin can make one for an organization: Projects → + new (the organization is chosen first), or + Project on the organization's page; the page is called New project. Either way the project goes through the same approvals.

The order form has:

  • Short name: 4-15 lowercase latin letters, digits and -, starting with a letter, unique in the organization. The project's OpenNebula group will be _<organization>_<name> (the name without -).
  • Type: cloud or corporate. Only corporate organizations can choose; for the others it is cloud.
  • Stage (POC or client) and the review date. The date is a month ahead by default; a POC ordered by the organization is reviewed within 3 months.
  • Team: the project admin, a user of the organization who gets the access details. The support engineer is assigned by the resource manager.
  • Resources: the site and the cluster, then the resources, storage and backups. GPU capacity is ordered in bundles: one bundle is one GPU card together with a fixed share of its server's cores and memory, so a bundle always fits on the machine the card is in; the bundle size (vCores and GB RAM per card, and optionally storage) is a setting of the GPU cluster. The resource fields follow the cluster, in the new project, Order resources and Change resources forms alike:

    • A CPU cluster: vCPU, RAM, GB and Storage, GB, typed in. There is no GPU field.
    • A GPU cluster: GPU bundles, chosen from a list. vCPU and RAM, GB are shown, not typed: the bundles × the bundle's vCPU and RAM. Storage, GB is typed in, or, when the cluster's bundle includes storage, shown as the bundles × that storage. A line under the fields spells the bundle out, e.g. "2 × (1 GPU NVIDIA L40S 48 GB + 16 vCPU + 120 GB RAM + 500 GB) · Bundles available: 3".

    The list of bundles goes up to what the cluster has free (its cards less the spare hosts' cards and the cards already allocated). When a pool's resources are changed, the list goes up to the pool's bundles plus the free ones, and starts at the bundles the pool's VMs use now. While the bundle count stays, the pool keeps its vCPU and RAM as they are. The portal checks the same limits when the form is sent: more bundles than are free are refused ("Only N bundles are free on this cluster.").

  • Connectivity: at least one of internet, corporate network (corporate organizations only) and external L2 channel. The internet and the corporate network cannot be combined. For the internet: the speed (10-1000 Mbit/s) and the prefixes: the main one and, with + prefix, additional ones. Each prefix has two choices, in this order:

    • Base subnet: the subnet its addresses are taken from, one of the internet subnets delegated to the exchange networks of the platform the chosen cluster is on, or auto (the default: the portal picks, cloud pools first). The list follows the cluster chosen above. The chosen subnet is tried first; when it has no free block of that size, the addresses come from the others.
    • Prefix length, from a list: /31, then /29, /28 and so on down to the largest block the site offers (the max of the site's internet IP subnets). /30 is not offered.

    For the corporate network: the base subnet and the prefix length, both chosen from lists, as for the internet.

    With the internet the order also chooses the project's gateway: advanced (the default), the platform's native router, or your own. With your own, nothing is created for you: the address is reserved and your virtual machine takes it.

  • Notes.

Nothing is made on the platform by the order: it waits for approval ("Project ordered. It will be available after approval."). The addresses are assigned when the resource manager approves; provisioning starts by itself when the last approval is given. Until then the organization's admins (or a resource manager) can cancel the request. An order is decided once. If it is cancelled or rejected while someone approves it, the cancellation or rejection stands: no addresses are allocated and nothing is provisioned, and the page says the request was already decided. Approvals given at the same moment by different roles are all kept.

Approval

The resource manager confirms the project's name and type, places it (site and cluster, internet address pool) and confirms the resources and the project admin. The internet address pool shows the base subnet ordered for the main prefix and can be changed; when the ordered base subnet is not one the platform provides, the pool is set to auto; the additional prefixes keep the base subnets ordered. The sales rep approves cloud projects and the support engineer corporate projects, each when its box is ticked in Settings → Customer → Approvals; without the resource manager's step, an order is approved as it was ordered. Who approves what, and when a step is skipped, is on Approvals.

A project from order to provisioned:

flowchart TB
    O[Order<br/>org admin or resource manager] --> RM{Resource manager<br/>names, places, confirms}
    O -. resource manager's box cleared .-> AO[Approved as ordered<br/>else the step goes to a super admin]
    AO --> S
    RM -- reject --> X[Rejected<br/>org admins told]
    RM -- approve --> S{Box ticked for the project's type?<br/>cloud: sales rep · corporate: support engineer}
    S -- yes --> SR{Sales rep or<br/>support engineer}
    SR -- reject --> X
    SR -- approve --> A[Last approval]
    S -- no --> A
    A --> P[Provisioning starts by itself<br/>defaults: OpenNebula admin, internet gateway<br/>1 vCPU / 1 GB RAM, project admin]
    P --> D[Deployment<br/>group, admin, quota, ACL,<br/>network, egw, igw]
    D -- failed / could not start --> R[Provision again<br/>goes on from what was made]
    R --> D
    D -- done --> M1[E-mail to the project admin<br/>access details, no copy]
    M1 --> M2[Same e-mail to each organization admin<br/>who is not the project admin]
    M1 -- sent --> M3[Notice to each platform user<br/>of the project]
    M1 -- not sent --> H[Platform users not told<br/>logged]

Provisioning and the e-mails it sends

When the last required approval is given, the project is provisioned at once, with the defaults: the OpenNebula admin <organization>-<project>-adm with a generated password; with the internet, the internet gateway of the type chosen in the order: an advanced (VyOS) one with the user <project>-igw-admin, a generated password and no ssh key (the gateway accepts password login), an ssh port from the range in Settings → Security, its size (1 vCPU, 1 GB RAM), or the platform's native router, or, with your own, nothing (its address is reserved for your VM); and the project admin chosen in the order. Provisioning is done by the portal: nobody presses a button. Provision again appears on the project only when the provisioning could not start (the platform is read-only, for example) or failed; it goes on from what was made. The project's organization admins and project admins, its support engineer and a super admin can use it. A project is provisioned once at a time: if someone else's provisioning of the same project is running or has just finished, Provision is refused and the passwords entered are not kept - the ones of that provisioning stand.

The deployment makes the project's group, its admin, the quotas, the access rules, the main public network, the provider's edge gateway and the project's internet gateway; every step can be run again. The internet gateway is made with 1 vCPU and 1 GB RAM by default (Provision again lets them be chosen).

flowchart TB
    A[Last approval] --> P[Provisioning starts by itself]
    P --> D{Deployment}
    D -- done --> M1[Access details to the project admin]
    M1 --> M2[Same e-mail to each organization admin<br/>who is not the project admin]
    M1 -- sent --> M3[Notice to each platform user of the project]
    D -- failed / could not start --> R[Provision again on the project]

When the deployment is done, the project admin gets the project's access details: the organization, the platforms, the resource pools per site and cluster (vCPU, RAM, GPU bundles, disk for VMs and images, files, backups), the web interface and API endpoints, the OpenNebula admin and password, the connections (internet speed, the main subnet, the addresses free for VMs, the edge and internet gateway addresses, the gateway's ssh access), the corporate networks and L2 channels, and its platform users with their e-mail addresses.

The access details go to the project admin only: nobody gets a copy. Every organization admin who is not the project admin gets the same e-mail of their own. Only when the project admin's e-mail went out are the project's platform users told. Resend credentials sends it again to the project admin only. After a project moves to another organization, the people of the former organization no longer receive its access details; the new organization's project admin receives them.

New users of a project get their access details by e-mail as soon as the project is provisioned, without a separate invitation.

The platform users of the project (sales rep, key account manager of a cloud project, resource manager, support engineer; one e-mail per person whatever their roles) are told the project is provisioned, with the same details but no passwords and no gateway access. When the project admin's e-mail could not be sent (or the project has no admin), nobody else is told and the portal logs it.

sequenceDiagram
    actor A as Last approver
    participant Portal
    participant ON as OpenNebula
    actor TA as Project admin
    actor OA as Organization admins<br/>(not the project admin)
    actor PU as Platform users of the project
    A->>Portal: last approval
    Portal->>ON: provisioning starts by itself: group, admin, quotas,<br/>access rules, main network, egw, igw (1 vCPU / 1 GB)
    Portal->>TA: e-mail: access details (passwords, gateway access)
    Portal->>OA: the same e-mail, one each
    alt the project admin's e-mail went out
        Portal->>PU: one e-mail each: provisioned, no passwords, no gateway access
    else not sent, or no project admin
        Note over Portal,PU: the platform users are not told, the portal logs it
    end
    Note over Portal,ON: failed or could not start: Provision again on the project

Changes after provisioning

Each resource pool shows its quota and, beside it, what is in use, with a bar that fills as the pool fills. The storage figure is broken into virtual machine disks, images and files.

The backup allowance belongs to the site, not to a single resource pool. It is shown and changed on the first resource pool of each site, and the change applies to every pool the project has there.

A project's quota is set on its OpenNebula group, never on its users, in every zone where it has a resource pool: each zone keeps its own quotas, and the group gets, in each zone, the vCPU, RAM, GPUs and storage of its pools there. Every approved order or change of a pool is followed by the quota changes, and the result names each zone (for example "dc1: quota set … · dc2: quota set …"). When the project's last pool in a zone is removed, its quota there is reset and its access rules there are removed. A cluster on a platform outside the project's OpenNebula federation cannot be ordered for it.

Every change of a provisioned project that costs money or touches the shared network is a request for approval; a resource manager (or a super admin) approves it, and it is carried out at once.

  • Size: the project's admins ask for other figures of a resource pool (vCPU, RAM or GPU bundles, storage, backups), or order another resource pool, on another cluster or on a new site. Splitting the storage between VM disks, images and files needs no approval. A change never goes below what the project uses now (the last reading of the platform): the form shows the usage next to each field and takes nothing below it, and a request or an approval below it is refused with the list of what is in use. A resource pool can be removed while the project still has VMs on it: the request lists those VMs and asks to confirm their deletion, and the site's images, files and backups must still fit in the pools that stay. When a pool is removed together with its VMs, the VMs are deleted first, and the pool is removed only once they are gone. If its VMs cannot be listed or deleted, the request stays waiting for approval and can be approved again; the pool, its quota and its access rules stay as they were. The pool's quota and access rules in its zone are closed even when its cluster has been retired since. If the pool's zone cannot be found any more, the change waits and nothing is changed. A resource change is decided once. If it is cancelled or rejected while someone approves it, the cancellation or rejection stands: no quota changes and, for a pool's removal, no VM is deleted; the page says the change was already decided. While an approved change is applied - the pool's VMs deleted, the quota written - it shows as "being applied", and it is "approved" only once its quota is in place. If it does not finish (for example, the portal restarted meanwhile), it stays "being applied", and after 10 minutes a resource manager can approve it again: the portal deletes only the VMs still there and writes the quota. A change being applied can no longer be cancelled or rejected, and a new change waits until it is done. A change never sets a pool's images or files below what the site stores: when they were set lower earlier, the change lifts them to what is stored (out of the new storage) and the page shows the split it will apply. A change the portal refuses says why on the page. A GPU pool is changed in bundles: a change that keeps the pool's bundle count (a storage-only change, for example) keeps its vCPU and RAM as they are, even when they differ from that many standard bundles; fewer bundles must still carry the cores and memory in use, and never fewer than the GPUs in use.
  • Speed and subnets: on the Internet table (below).
  • Corporate networks and L2 channels: + prefix on the Corporate table; + Channel (external, for approval) and + Internal channel (between two sites, without approval) on the L2 table (see L2 channels).
  • Organization: a resource manager asks to move the project to another organization (see Approvals).

A project has one internet connection per site; its resource pools can be on several sites, so the Internet table can have several rows, one per site: the site, the speed, the internet gateway's type and the subnets (the main one first). The row of the project's own site has the actions: Speed (a new speed, for approval), Type (the internet gateway's type, at once, without approval), Main (replace the main subnet, for approval: the dialog lists what happens after approval), + Subnet (an additional public subnet, for approval) and − Subnet (remove an additional one, for approval; shown when the row has one). Every request belongs to the row's site. The portal makes and changes a project's networks on the project's own site (the site it was ordered on). The Internet table may also list the project's other sites; there, changes are asked through support, and the row says so instead of offering the buttons. Main and + Subnet also offer the Base subnet (or auto), as in the order; the resource manager sees the choice and can change it when approving.

flowchart TB
  H["Project → Internet<br/>one row per site"]
  H --- R1["Row of dc1, the project's own site · 100 Mbit/s · VyOS · main /31, additional /29<br/>Speed · Type · Main · + Subnet · − Subnet"]
  H --- R2["Row of dc2, another site · 50 Mbit/s · VyOS · main /31<br/>Changes on this site: through support"]
  R1 -- request of dc1 --> AP([Resource manager approves])
  AP --> C[Carried out on that site's gateways]

The internet gateway's size changes in its Edit dialog; see Approvals and the portal reference.

L2 channels

The L2 table of a project lists its channels with their type · endpoint 1 · endpoint 2 · state. There are two kinds:

Type What it joins Endpoint 1 Endpoint 2 How it is added
external a VLAN from the client's side and a project network, over VXLAN the VLAN the project network + Channel: a resource manager approves it, then the support engineer sets the VLAN
internal two of the project's own networks on two different sites site 1 · its network site 2 · its network + Internal channel: added without approval. Offered when the project has resources on two sites; one channel per pair of sites

Either kind is removed with Remove on its row (for approval); the network a channel joins is changed with Change subnet, without approval. The subnet of an L2 channel is always one of the project's own subnets; another project's network, or one of the provider's, is refused.

Every e-mail on the way

When To In copy What it says
An organization is registered the person registering — confirm your address
The address is confirmed resource managers — a new organization is waiting for approval
The resource manager approved (sales approval on, cloud) the organization's sales rep — waiting for your approval
The registration is approved the organization admin — registered: sign in and order resources
The registration is refused the person registering — refused, with the reason
A project is ordered, or a step is approved whoever approves next, in the roles ticked for them — waiting for your approval
A project is rejected the organization's admins — rejected, with the reason
A project is provisioned the project admin — the access details, with passwords and gateway access
… the same each organization admin who is not the project admin — the same access details
… after the project admin's e-mail went out each platform user of the project (sales rep, KAM, resource manager, support engineer), once per person — provisioned, without passwords or gateway access
Resend credentials the project admin — the access details
A network change is requested the project's resource manager (or the resource managers) — waiting for your approval
A deletion is requested the project's resource manager (or the resource managers) — waiting for your approval
A project is to move to another organization whoever approves the move (resource manager, the new organization's sales rep) — the move waits for your approval
A contract or POC runs out the organization admins — expiration notice (see Project lifecycle)
The super admin role is to be given or taken away every super admin and the person concerned — confirm or decline within 48 hours
On each report's schedule (Settings → Reports) resource managers, sales reps, KAMs, support engineers, super admins — their reports

While e-mail to organization users is off (Settings → Mail), organization users get no e-mail: their messages are kept on the portal and logged (mail_held), never sent; e-mail to platform users does the same for platform users. Every e-mail has its template in Settings → Mail.