{"id":20111531,"url":"https://github.com/openstack/charm-ceph-radosgw","last_synced_at":"2025-05-06T11:30:52.738Z","repository":{"id":66174596,"uuid":"52858698","full_name":"openstack/charm-ceph-radosgw","owner":"openstack","description":"Juju Charm - Ceph RADOS Gateway. Mirror of code maintained at opendev.org.","archived":false,"fork":false,"pushed_at":"2024-05-22T09:11:23.000Z","size":2126,"stargazers_count":13,"open_issues_count":0,"forks_count":9,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-05-22T10:35:33.981Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://opendev.org/openstack/charm-ceph-radosgw","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:53:41.000Z","updated_at":"2024-05-07T15:52:10.000Z","dependencies_parsed_at":"2023-02-21T06:01:27.825Z","dependency_job_id":"97d146ce-4fa8-4466-ba59-dda0596e2897","html_url":"https://github.com/openstack/charm-ceph-radosgw","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fcharm-ceph-radosgw","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fcharm-ceph-radosgw/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fcharm-ceph-radosgw/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fcharm-ceph-radosgw/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openstack","download_url":"https://codeload.github.com/openstack/charm-ceph-radosgw/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:27.526Z","updated_at":"2024-11-13T18:16:28.178Z","avatar_url":"https://github.com/openstack.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Overview\n\n[Ceph][ceph-upstream] is a unified, distributed storage system designed for\nexcellent performance, reliability, and scalability.\n\nThe ceph-radosgw charm deploys the RADOS Gateway, a S3 and Swift compatible\nHTTP gateway. The deployment is done within the context of an existing Ceph\ncluster.\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#### `pool-type`\n\nThe `pool-type` option dictates the storage pool type. See section 'Ceph pool\ntype' for more information.\n\n#### `source`\n\nThe `source` option states the software sources. A common value is an OpenStack\nUCA release (e.g. 'cloud:xenial-queens' or 'cloud:bionic-ussuri'). See [Ceph\nand the UCA][cloud-archive-ceph]. The underlying host's existing apt sources\nwill be used if this option is not specified (this behaviour can be explicitly\nchosen by using the value of 'distro').\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 Object storage.\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 rgw pools. Increasing this value increases data resilience at\nthe cost of consuming more real storage in the Ceph cluster. The default value\nis '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 coded pools for Object storage multiple pools will be\ncreated: one erasure coded pool ('rgw.buckets.data' for storing actual RGW\ndata) and several replicated pools (for storing RGW omap metadata). The\n`ceph-osd-replication-count` configuration option only applies to the metadata\n(replicated) pools.\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\nCeph RADOS Gateway is often containerised. Here a single unit is deployed to a\nnew container on machine '1' within an existing Ceph cluster:\n\n    juju deploy --to lxd:1 ceph-radosgw\n    juju add-relation ceph-radosgw:mon ceph-mon:radosgw\n\nIf the RADOS Gateway is being integrated into OpenStack then a relation to the\nkeystone application is needed:\n\n    juju add-relation ceph-radosgw:identity-service keystone:identity-service\n\nExpose the service:\n\n    juju expose ceph-radosgw\n\n\u003e **Note**: The `expose` command is only required if the backing cloud blocks\n  traffic by default. In general, MAAS is the only cloud type that does not\n  employ firewalling.\n\nThe Gateway can be accessed over port 80 (as per `juju status ceph-radosgw`\noutput).\n\n## Multi-site replication\n\nThe charm supports native replication between multiple RADOS Gateway\ndeployments. This is documented under [Ceph RADOS Gateway multisite\nreplication][cdg-ceph-radosgw-multisite] in the [OpenStack Charms Deployment\nGuide][cdg].\n\n## Tenant namespacing\n\nBy default, Ceph RADOS Gateway puts all tenant buckets into the same global\nnamespace, disallowing multiple tenants to have buckets with the same name.\nTenant namespacing can be enabled in this charm by deploying with configuration\nlike:\n\n    ceph-radosgw:\n      charm: cs:ceph-radosgw\n      num_units: 1\n      options:\n        namespace-tenants: True\n\nEnabling tenant namespacing will place all tenant buckets into their own\nnamespace under their tenant id, as well as adding the tenant's ID parameter to\nthe Keystone endpoint registration to allow seamless integration with OpenStack.\nTenant namespacing cannot be toggled on in an existing installation as it will\nremove tenant access to existing buckets. Toggling this option on an already\ndeployed RADOS Gateway will have no effect.\n\n## Access\n\nFor security reasons the charm is not designed to administer the Ceph cluster.\nA user (e.g. 'ubuntu') for the Ceph Object Gateway service will need to be\ncreated manually:\n\n    juju ssh ceph-mon/0 'sudo radosgw-admin user create \\\n       --uid=\"ubuntu\" --display-name=\"Charmed Ceph\"'\n\n## Keystone integration (Swift)\n\nCeph RGW supports Keystone authentication of Swift requests. This is enabled\nby adding a relation to an existing keystone application:\n\n    juju add-relation ceph-radosgw:identity-service keystone:identity-service\n\n## High availability\n\nWhen more than one unit is deployed with the [hacluster][hacluster-charm]\napplication the charm will bring up an HA active/active cluster.\n\nThere are two mutually exclusive high availability options: using virtual IP(s)\nor DNS. In both cases the hacluster subordinate charm is used to provide the\nCorosync and Pacemaker backend HA functionality.\n\nSee [OpenStack high availability][cdg-ha-apps] in the [OpenStack Charms\nDeployment Guide][cdg] for details.\n\n## S3 Interface Support\n\nThis charm provides [s3 charm interface support][s3spec]. This means\nit can act as a provider for applications wishing to make use of S3\nobject storage via this relation. An application that implements the\ns3 requirer side of this relation will can be related to ceph-radosgw.\nUsing the mysql-operator charm as an example:\n\n    juju add-relation ceph-radosgw:s3 mysql:s3-parameters\n\nUpon forming that relation, ceph-radosgw will create a bucket for use\nby the requirer, and transmit access information back to the requirer.\nThe requirer then could use this to connect to the S3 endpoint to\nstore application data.\n\nOnly a single bucket will be created per requirer application. If an\napplication relation is removed, the bucket *will* be preserved. If\nsubsequently the application reestablishes the relation, the bucket\nwill be reused.\n\n\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\nAPI endpoints can be bound to distinct network spaces supporting the network\nseparation of public, internal and admin endpoints.\n\nFor example, providing that spaces 'public-space', 'internal-space', and\n'admin-space' exist, the deploy command above could look like this:\n\n    juju deploy ceph-radosgw \\\n       --bind \"public=public-space internal=internal-space admin=admin-space\"\n\nAlternatively, configuration can be provided as part of a bundle:\n\n```yaml\n    ceph-radosgw:\n      charm: cs:ceph-radosgw\n      num_units: 1\n      bindings:\n        public: public-space\n        internal: internal-space\n        admin: admin-space\n```\n\n\u003e **Note**: Existing ceph-radosgw units configured with the `os-admin-network`,\n  `os-internal-network`, `os-public-network`, `os-public-hostname`,\n  `os-internal-hostname`, or `os-admin-hostname` options will continue to\n  honour them. Furthermore, these options override any space bindings, if set.\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 ceph-radosgw`. If the charm is\nnot deployed then see file `actions.yaml`.\n\n* `pause`\n* `promote`\n* `readonly`\n* `readwrite`\n* `resume`\n* `tidydefaults`\n* `enable-buckets-sync`\n* `disable-buckets-sync`\n* `reset-buckets-sync`\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-ceph-radosgw].\n\n\u003c!-- LINKS --\u003e\n\n[juju-docs-actions]: https://jaas.ai/docs/actions\n[ceph-upstream]: https://ceph.io\n[hacluster-charm]: https://jaas.ai/hacluster\n[cg]: https://docs.openstack.org/charm-guide\n[cdg]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide\n[cdg-ha-apps]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/app-ha.html#ha-applications\n[cloud-archive-ceph]: https://wiki.ubuntu.com/OpenStack/CloudArchive#Ceph_and_the_UCA\n[juju-docs-config-apps]: https://juju.is/docs/configuring-applications\n[cdg-ceph-erasure-coding]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/app-erasure-coding.html\n[lp-bugs-charm-ceph-radosgw]: https://bugs.launchpad.net/charm-ceph-radosgw/+filebug\n[juju-docs-spaces]: https://jaas.ai/docs/spaces\n[cdg-ceph-radosgw-multisite]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide/latest/app-rgw-multisite.html\n[ceph-bluestore-compression]: https://docs.ceph.com/en/latest/rados/configuration/bluestore-config-ref/#inline-compression\n[s3spec]: https://github.com/canonical/charm-relation-interfaces/tree/main/interfaces/s3/v0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fcharm-ceph-radosgw","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenstack%2Fcharm-ceph-radosgw","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fcharm-ceph-radosgw/lists"}