{"id":20111421,"url":"https://github.com/openstack/charm-cinder-ceph","last_synced_at":"2025-05-06T10:33:29.914Z","repository":{"id":66174590,"uuid":"52858727","full_name":"openstack/charm-cinder-ceph","owner":"openstack","description":"Juju Charm - Cinder Ceph backend. Mirror of code maintained at opendev.org.","archived":false,"fork":false,"pushed_at":"2024-08-21T08:46:52.000Z","size":1548,"stargazers_count":12,"open_issues_count":0,"forks_count":7,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-08-21T10:09:13.428Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://opendev.org/openstack/charm-cinder-ceph","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:54:12.000Z","updated_at":"2024-08-21T08:46:55.000Z","dependencies_parsed_at":"2023-02-20T23:15:52.850Z","dependency_job_id":"dabcff1c-ad65-4637-a1cd-59883b5f2b77","html_url":"https://github.com/openstack/charm-cinder-ceph","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-cinder-ceph","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fcharm-cinder-ceph/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fcharm-cinder-ceph/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fcharm-cinder-ceph/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openstack","download_url":"https://codeload.github.com/openstack/charm-cinder-ceph/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:16:01.602Z","updated_at":"2024-11-13T18:16:02.276Z","avatar_url":"https://github.com/openstack.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Overview\n\n[Cinder][cinder-upstream] is the OpenStack block storage (volume) service.\n[Ceph][ceph-upstream] is a unified, distributed storage system designed for\nexcellent performance, reliability, and scalability. Ceph-backed Cinder\ntherefore allows for scalability and redundancy for storage volumes. This\narrangement is intended for large-scale production deployments.\n\nThe cinder-ceph charm provides a Ceph (RBD) storage backend for Cinder and is\nused in conjunction with the [cinder][cinder-charm] charm and an existing Ceph\ncluster (via the [ceph-mon][ceph-mon-charm] or the\n[ceph-proxy][ceph-proxy-charm] charms).\n\nSpecialised use cases:\n\n* Through the use of multiple application names (e.g. cinder-ceph-1,\n  cinder-ceph-2), multiple Ceph clusters can be associated with a single Cinder\n  deployment.\n\n* A variety of storage types can be achieved with a single Ceph cluster by\n  mapping pools with multiple cinder-ceph applications. For instance, different\n  pools could be used for HDD or SSD devices. See option `rbd-pool-name` below.\n\n\u003e **Note**: There is currently no upgrade path to using the cinder-ceph charm\n  for older deployments that have the cinder and ceph-mon applications related\n  directly. This issue is tracked in bug [LP #1727184][lp-bug-1727184].\n\n# Usage\n\n## Configuration\n\nTo display all configuration option information run `juju config\n\u003capplication\u003e`. If the application is not deployed then see the charm's\n[Configure tab][cinder-ceph-configure] in the Charmhub. Finally, the [Juju\ndocumentation][juju-docs-config-apps] provides general guidance on configuring\napplications.\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 Cinder volumes.\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 'cinder-ceph' 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 (or ceph-proxy) application. Otherwise,\n  the pool's configuration will need to be set by interfacing with the cluster\n  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 coded pools for Cinder volumes two pools will be created: a\nreplicated pool (for storing RBD metadata) and an erasure coded pool (for\nstoring the data written into the RBD). The `ceph-osd-replication-count`\nconfiguration option only applies 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\nThe cinder-ceph application requires the cinder application and a Ceph cluster\nto be present.\n\nFirst configure Cinder to not use a local block device. Then deploy\ncinder-ceph, and add a relation to both the cinder and ceph-mon applications:\n\n    juju config cinder block-device=None\n    juju deploy cinder-ceph\n    juju add-relation cinder-ceph:storage-backend cinder:storage-backend\n    juju add-relation cinder-ceph:ceph ceph-mon:client\n\nAdditionally, when both the nova-compute and cinder-ceph applications are\ndeployed a relation is needed between them:\n\n    juju add-relation cinder-ceph:ceph-access nova-compute:ceph-access\n\n# Documentation\n\nThe OpenStack Charms project maintains two documentation guides:\n\n* [OpenStack Charm Guide][cg]: the primary source of information for\n  OpenStack charms\n* [OpenStack Charms Deployment Guide][cdg]: a step-by-step guide for\n  deploying OpenStack with charms\n\n# Bugs\n\nPlease report bugs on [Launchpad][cinder-ceph-filebug].\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[ceph-upstream]: https://ceph.io\n[cinder-upstream]: https://docs.openstack.org/cinder\n[cinder-charm]: https://charmhub.io/cinder\n[ceph-mon-charm]: https://charmhub.io/ceph-mon\n[ceph-proxy-charm]: https://charmhub.io/ceph-proxy\n[cinder-purestorage-charm]: https://charmhub.io/cinder-purestorage\n[juju-docs-config-apps]: https://juju.is/docs/olm/configure-an-application\n[cinder-ceph-configure]: https://charmhub.io/cinder-ceph/configure\n[cinder-ceph-filebug]: https://bugs.launchpad.net/charm-cinder-ceph/+filebug\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[lp-bug-1727184]: https://bugs.launchpad.net/charm-cinder-ceph/+bug/1727184\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fcharm-cinder-ceph","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenstack%2Fcharm-cinder-ceph","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fcharm-cinder-ceph/lists"}