{"id":20111335,"url":"https://github.com/openstack/charm-nova-compute","last_synced_at":"2025-05-06T10:33:05.086Z","repository":{"id":49378991,"uuid":"52858872","full_name":"openstack/charm-nova-compute","owner":"openstack","description":"Juju Charm - Nova Compute. Mirror of code maintained at opendev.org.","archived":false,"fork":false,"pushed_at":"2024-09-16T18:18:33.000Z","size":4087,"stargazers_count":16,"open_issues_count":0,"forks_count":29,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-09-16T22:54:42.207Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://opendev.org/openstack/charm-nova-compute","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openstack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-03-01T07:56:18.000Z","updated_at":"2024-08-22T16:47:33.000Z","dependencies_parsed_at":"2023-02-14T15:46:12.804Z","dependency_job_id":"947ae4d4-3e0f-4971-8971-75fcd7ec0d23","html_url":"https://github.com/openstack/charm-nova-compute","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fcharm-nova-compute","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fcharm-nova-compute/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fcharm-nova-compute/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fcharm-nova-compute/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openstack","download_url":"https://codeload.github.com/openstack/charm-nova-compute/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224499851,"owners_count":17321605,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-13T18:15:38.875Z","updated_at":"2024-11-13T18:15:39.550Z","avatar_url":"https://github.com/openstack.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Overview\n\nThe nova-compute charm deploys [Nova Compute][upstream-compute], the core\nOpenStack service that provisions virtual instances (VMs) and baremetal servers\n(via [Ironic][cdg-ironic]). The charm works alongside other Juju-deployed\nOpenStack services.\n\n# Usage\n\n## Configuration\n\nThis section covers common and/or important configuration options. See file\n`config.yaml` for the full list of options, along with their descriptions and\ndefault values. See the [Juju documentation][juju-docs-config-apps] for details\non configuring applications.\n\n#### `config-flags`\n\nA comma-separated list of key=value configuration flags. These values will be\nplaced in the [DEFAULT] section of the `nova.conf` file.\n\n#### `enable-live-migration`\n\nAllows the live migration of VMs.\n\n#### `enable-resize`\n\nAllows the resizing of VMs.\n\n#### `migration-auth-type`\n\nSelects the TCP authentication scheme to use for live migration. The only\naccepted value is 'ssh'.\n\n#### `customize-failure-domain`\n\nWhen MAAS is the backing cloud and this option is set to 'true' then all\nMAAS-defined zones will become available as Nova availability zones, and option\n`default-availability-zone` will be overridden. See section [Availability\nZones][anchor-az].\n\n#### `default-availability-zone`\n\nSets a single default Nova availability zone. It is used when a VM is created\nwithout a Nova AZ being specified. The default value is 'nova'. A non-default\nNova AZ must be created manually (i.e. `openstack aggregate create`). See\nsection [Availability Zones][anchor-az].\n\n#### `libvirt-image-backend`\n\nSpecifies what image backend to use. Possible values are 'rbd', 'qcow2',\n'raw', and 'flat'. The default behaviour is for Nova to use qcow2.\n\n#### `openstack-origin`\n\nStates the software sources. A common value is an OpenStack UCA release (e.g.\n'cloud:bionic-train' or 'cloud:focal-wallaby'). See [Ubuntu Cloud\nArchive][wiki-uca]. The underlying host's existing apt sources will be used if\nthis option is not specified (this behaviour can be explicitly chosen by using\nthe value of 'distro').\n\n#### `pool-type`\n\nDictates the Ceph storage pool type. See sections [Ceph pool\ntype][anchor-ceph-pool-type] and [RBD Nova images][anchor-rbd-nova-images] for\nmore information.\n\n## Ceph pool type\n\nCeph storage pools can be configured to ensure data resiliency either through\nreplication or by erasure coding. This charm supports both types via the\n`pool-type` configuration option, which can take on the values of 'replicated'\nand 'erasure-coded'. The default value is 'replicated'.\n\nFor this charm, the pool type will be associated with Nova-managed images.\n\n\u003e **Note**: Erasure-coded pools are supported starting with Ceph Luminous.\n\n### Replicated pools\n\nReplicated pools use a simple replication strategy in which each written object\nis copied, in full, to multiple OSDs within the cluster.\n\nThe `ceph-osd-replication-count` option sets the replica count for any object\nstored within the 'nova' rbd pool. Increasing this value increases data\nresilience at the cost of consuming more real storage in the Ceph cluster. The\ndefault value is '3'.\n\n\u003e **Important**: The `ceph-osd-replication-count` option must be set prior to\n  adding the relation to the ceph-mon application. Otherwise, the pool's\n  configuration will need to be set by interfacing with the cluster directly.\n\n### Erasure coded pools\n\nErasure coded pools use a technique that allows for the same resiliency as\nreplicated pools, yet reduces the amount of space required. Written data is\nsplit into data chunks and error correction chunks, which are both distributed\nthroughout the cluster.\n\n\u003e **Note**: Erasure coded pools require more memory and CPU cycles than\n  replicated pools do.\n\nWhen using erasure coding two pools will be created: a replicated pool (for\nstoring RBD metadata) and an erasure coded pool (for storing the data written\ninto the RBD). The `ceph-osd-replication-count` configuration option only\napplies to the metadata (replicated) pool.\n\nErasure coded pools can be configured via options whose names begin with the\n`ec-` prefix.\n\n\u003e **Important**: It is strongly recommended to tailor the `ec-profile-k` and\n  `ec-profile-m` options to the needs of the given environment. These latter\n  options have default values of '1' and '2' respectively, which result in the\n  same space requirements as those of a replicated pool.\n\nSee [Ceph Erasure Coding][cdg-ceph-erasure-coding] in the [OpenStack Charms\nDeployment Guide][cdg] for more information.\n\n## Ceph BlueStore compression\n\nThis charm supports [BlueStore inline compression][ceph-bluestore-compression]\nfor its associated Ceph storage pool(s). The feature is enabled by assigning a\ncompression mode via the `bluestore-compression-mode` configuration option. The\ndefault behaviour is to disable compression.\n\nThe efficiency of compression depends heavily on what type of data is stored\nin the pool and the charm provides a set of configuration options to fine tune\nthe compression behaviour.\n\n\u003e **Note**: BlueStore compression is supported starting with Ceph Mimic.\n\n## Deployment\n\nThese deployment instructions assume that the following applications are\npresent: glance, nova-cloud-controller, ovn-chassis, and rabbitmq-server.\nStorage backends used for VM disks and volumes are configured separately (see\nsections [Ceph backed storage][anchor-ceph-backed-storage] and [Local Cinder\nstorage][anchor-local-cinder-storage].\n\nLet file `nova-compute.yaml` contain the deployment configuration:\n\n```yaml\n    nova-compute:\n      config-flags: default_ephemeral_format=ext4\n      enable-live-migration: true\n      enable-resize: true\n      migration-auth-type: ssh\n      openstack-origin: cloud:focal-wallaby\n```\n\nTo deploy nova-compute to machine '5':\n\n    juju deploy --to 5 --config nova-compute.yaml nova-compute\n    juju add-relation nova-compute:image-service glance:image-service\n    juju add-relation nova-compute:cloud-compute nova-cloud-controller:cloud-compute\n    juju add-relation nova-compute:neutron-plugin ovn-chassis:nova-compute\n    juju add-relation nova-compute:amqp rabbitmq-server:amqp\n\n### Ceph backed storage\n\nTwo concurrent Ceph backends are supported: RBD Nova images and RBD Cinder\nvolumes. Each backend uses its own set of cephx credentials.\n\nThe steps below assume a pre-existing Ceph cluster (see the\n[ceph-mon][ceph-mon-charm] and [ceph-osd][ceph-osd-charm] charms).\n\n#### RBD Nova images\n\nRBD Nova images are enabled by setting option `libvirt-image-backend` to 'rbd'\nand by adding a relation to the Ceph cluster:\n\n    juju config nova-compute libvirt-image-backend=rbd\n    juju add-relation nova-compute:ceph ceph-mon:client\n\n\u003e **Warning**: Changing the value of option `libvirt-image-backend` will orphan\n  any disks that were set up under a different setting. This will cause the\n  restarting of associated VMs to fail.\n\nThis solution will place both root and ephemeral disks in Ceph.\n\n\u003e **Pro tip**: An alternative is to selectively store just root disks in Ceph\n  by using Cinder as an intermediary. See section [RBD Cinder\n  volumes][anchor-rbd-cinder] as well as [Launch an instance from a\n  volume][upstream-volume-boot] in the Nova documentation.\n\n#### RBD Cinder volumes\n\nRBD Cinder volumes are enabled by adding a relation to Cinder via the\ncinder-ceph application. Assuming Cinder is already backed by Ceph (see the\n[cinder-ceph][cinder-ceph-charm] charm):\n\n    juju add-relation nova-compute:ceph-access cinder-ceph:ceph-access\n\n\u003e **Note**: The `nova-compute:ceph-access` relation is not needed for OpenStack\n  releases older than Ocata.\n\n### Local Cinder storage\n\nTo use local storage, Cinder will need to be configured to use local block\ndevices. See the [cinder][cinder-charm] charm for details.\n\n## Availability Zones\n\nNova AZs can be matched with MAAS zones depending on how options\n`default-availability-zone` and `customize-failure-domain` are configured. See\n[Availability Zones][cdg-ha-az] in the [OpenStack Charms Deployment Guide][cdg]\nfor in-depth coverage of how this works.\n\n## SSH keys and VM migration\n\nVM migration requires the sharing of public SSH keys (host and several select\nusers) among the compute hosts. By design, only those hosts belonging to the\nsame application group will get each other's keys. This means that VM migration\ncannot occur (without manual intervention) between hosts belonging to different\ngroups.\n\n\u003e **Note:** The policy of only sharing SSH keys amongst hosts of the same\n  application group may be struck down. This is being tracked in bug [LP\n  #1468871][lp-bug-1468871].\n\n## NFV support\n\nThis charm (in conjunction with the nova-cloud-controller and neutron-api\ncharms) supports NFV for Compute nodes that are deployed in Telco NFV\nenvironments.\n\nFor more information on NFV see the [Network Functions Virtualization\n(NFV)][cdg-nfv] page in the [OpenStack Charms Deployment Guide][cdg].\n\n## Network spaces\n\nThis charm supports the use of Juju [network spaces][juju-docs-spaces] (Juju\n`v.2.0`). This feature optionally allows specific types of the application's\nnetwork traffic to be bound to subnets that the underlying hardware is\nconnected to.\n\n\u003e **Note**: Spaces must be configured in the backing cloud prior to deployment.\n\nIn addition this charm declares two extra-bindings:\n\n* `internal`: used to determine the network space to use for console access to\n  instances.\n\n* `migration`: used to determine which network space should be used for live\n  and cold migrations between hypervisors.\n\nNote that the nova-cloud-controller application must have bindings to the same\nnetwork spaces used for both 'internal' and 'migration' extra bindings.\n\n## Scaling back\n\nScaling back the nova-compute application implies the removal of one or more\ncompute nodes. This is documented as a cloud operation in the [OpenStack Charms\nDeployment Guide][cdg]. See [Remove a Compute\nnode][cdg-ops-scale-in-nova-compute].\n\n## Actions\n\nThis section lists Juju [actions][juju-docs-actions] supported by the charm.\nActions allow specific operations to be performed on a per-unit basis. To\ndisplay action descriptions run `juju actions nova-compute`. If the charm is\nnot deployed then see file `actions.yaml`.\n\n* `disable`\n* `enable`\n* `hugepagereport`\n* `instance-count`\n* `list-compute-nodes`\n* `node-name`\n* `openstack-upgrade`\n* `pause`\n* `register-to-cloud`\n* `remove-from-cloud`\n* `resume`\n* `security-checklist`\n\n# Documentation\n\nThe OpenStack Charms project maintains two documentation guides:\n\n* [OpenStack Charm Guide][cg]: for project information, including development\n  and support notes\n* [OpenStack Charms Deployment Guide][cdg]: for charm usage information\n\n# Bugs\n\nPlease report bugs on [Launchpad][lp-bugs-charm-nova-compute].\n\n\u003c!-- LINKS --\u003e\n\n[cg]: https://docs.openstack.org/charm-guide\n[cdg]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide\n[juju-docs-actions]: https://jaas.ai/docs/actions\n[juju-docs-spaces]: https://juju.is/docs/spaces\n[juju-docs-config-apps]: https://juju.is/docs/configuring-applications\n[lp-bugs-charm-nova-compute]: https://bugs.launchpad.net/charm-nova-compute/+filebug\n[cdg-install-openstack]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/install-openstack.html\n[cloud-archive-ceph]: https://wiki.ubuntu.com/OpenStack/CloudArchive#Ceph_and_the_UCA\n[wiki-uca]: https://wiki.ubuntu.com/OpenStack/CloudArchive\n[cdg-ceph-erasure-coding]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/app-erasure-coding.html\n[ceph-bluestore-compression]: https://docs.ceph.com/en/latest/rados/configuration/bluestore-config-ref/#inline-compression\n[cdg-ops-scale-in-nova-compute]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/ops-scale-in-nova-compute.html\n[cdg-nfv]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/nfv.html\n[cdg-ironic]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/ironic.html\n[cinder-charm]: https://jaas.ai/cinder\n[cinder-ceph-charm]: https://jaas.ai/cinder-ceph\n[ceph-mon-charm]: https://jaas.ai/ceph-mon\n[ceph-osd-charm]: https://jaas.ai/ceph-osd\n[upstream-compute]: https://docs.openstack.org/nova/\n[cdg-ha-az]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/app-ha.html#availability-zones\n[anchor-az]: #availability-zones\n[anchor-ceph-pool-type]: #ceph-pool-type\n[anchor-ceph-backed-storage]: #ceph-backed-storage\n[anchor-local-cinder-storage]: #local-cinder-storage\n[anchor-rbd-nova-images]: #rbd-nova-images\n[anchor-rbd-cinder]: #rbd-cinder-volumes\n[upstream-volume-boot]: https://docs.openstack.org/nova/latest/user/launch-instance-from-volume.html\n[lp-bug-1468871]: https://bugs.launchpad.net/charms/+source/nova-cloud-controller/+bug/1468871\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fcharm-nova-compute","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenstack%2Fcharm-nova-compute","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fcharm-nova-compute/lists"}