{"id":20111481,"url":"https://github.com/openstack/charm-ceph-iscsi","last_synced_at":"2026-02-13T17:03:19.951Z","repository":{"id":66174606,"uuid":"286659975","full_name":"openstack/charm-ceph-iscsi","owner":"openstack","description":"Juju Charm - Ceph iSCSI. Mirror of code maintained at opendev.org.","archived":false,"fork":false,"pushed_at":"2024-11-19T09:26:59.000Z","size":161,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-08-27T11:17:03.012Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://opendev.org/openstack/charm-ceph-iscsi","language":"Python","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","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":null,"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,"zenodo":null}},"created_at":"2020-08-11T06:06:28.000Z","updated_at":"2024-11-19T09:27:03.000Z","dependencies_parsed_at":"2025-06-05T14:02:48.966Z","dependency_job_id":"00edd159-5fc4-4dda-afec-cc6fe85d43f1","html_url":"https://github.com/openstack/charm-ceph-iscsi","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/openstack/charm-ceph-iscsi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fcharm-ceph-iscsi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fcharm-ceph-iscsi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fcharm-ceph-iscsi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fcharm-ceph-iscsi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openstack","download_url":"https://codeload.github.com/openstack/charm-ceph-iscsi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openstack%2Fcharm-ceph-iscsi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29412670,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-13T06:24:03.484Z","status":"ssl_error","status_checked_at":"2026-02-13T06:23:12.830Z","response_time":78,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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:15.167Z","updated_at":"2026-02-13T17:03:19.931Z","avatar_url":"https://github.com/openstack.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Overview\n\nThe ceph-iscsi charm deploys the [Ceph iSCSI gateway\nservice][ceph-iscsi-upstream]. The charm is intended to be used in conjunction\nwith the [ceph-osd][ceph-osd-charm] and [ceph-mon][ceph-mon-charm] charms.\n\n**NOTE**: This charm is deprecated. No new features will be introduced.\n\n# Usage\n\n## Configuration\n\nSee file `config.yaml` for the full list of options, along with their\ndescriptions and default values.\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\nWe are assuming a pre-existing Ceph cluster.\n\nTo provide multiple data paths to clients deploy exactly two ceph-iscsi units:\n\n    juju deploy -n 2 ceph-iscsi\n\nThen add a relation to the ceph-mon application:\n\n    juju add-relation ceph-iscsi:ceph-client ceph-mon:client\n\n**Notes**:\n\n* Deploying four ceph-iscsi units is theoretically possible but it is not an\n  officially supported configuration.\n\n* The ceph-iscsi application cannot be containerised.\n\n* Co-locating ceph-iscsi with another application is only supported with\n  ceph-osd, although doing so with other applications may still work.\n\n## Actions\n\nThis section covers 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-iscsi`. If the charm is not\ndeployed then see file `actions.yaml`.\n\n* `add-trusted-ip`\n* `create-target`\n* `pause`\n* `resume`\n* `security-checklist`\n\nTo display action descriptions run `juju actions ceph-iscsi`. If the charm is\nnot deployed then see file `actions.yaml`.\n\n## iSCSI target management\n\n### Create an iSCSI target\n\nAn iSCSI target can be created easily with the charm's `create-target` action:\n\n    juju run-action --wait ceph-iscsi/0 create-target \\\n       client-initiatorname=iqn.1993-08.org.debian:01:aaa2299be916 \\\n       client-username=myiscsiusername \\\n       client-password=myiscsipassword \\\n       image-size=5G \\\n       image-name=small \\\n       pool-name=images\n\nIn the above, all option values are generally user-defined with the exception\nof the initiator name (`client-initiatorname`). An iSCSI initiator is\nessentially an iSCSI client and so its name is client-dependent. Some\ninitiators may impose policy on credentials (`client-username` and\n`client-password`).\n\n\u003e **Important**: The underlying machines for the ceph-iscsi units must have\n  internal name resolution working (i.e. the machines must be able to resolve\n  each other's hostnames).\n\n### The `gwcli` utility\n\nThe management of targets, beyond the target-creation action described above,\ncan be accomplished via the `gwcli` utility. This CLI tool has its own shell,\nand is available from any ceph-iscsi unit:\n\n    juju ssh ceph-iscsi/1\n    sudo gwcli\n    /\u003e help\n\n## VMware integration\n\nCeph can be used to back iSCSI targets for VMware initiators. This is\ndocumented under [VMware integration][ceph-docs-vmware-integration] in the\n[Charmed Ceph documentation][ceph-docs].\n\n# Bugs\n\nPlease report bugs on [Launchpad][lp-bugs-charm-ceph-iscsi].\n\nFor general charm questions refer to the [OpenStack Charm Guide][cg].\n\n\u003c!-- LINKS --\u003e\n\n[ceph-mon-charm]: https://jaas.ai/ceph-mon\n[ceph-osd-charm]: https://jaas.ai/ceph-osd\n[cg]: https://docs.openstack.org/charm-guide\n[cdg]: https://docs.openstack.org/project-deploy-guide/charm-deployment-guide\n[ceph-docs-vmware-integration]: https://ubuntu.com/ceph/docs/integration-vmware\n[ceph-docs]: https://ubuntu.com/ceph/docs\n[juju-docs-actions]: https://jaas.ai/docs/actions\n[ceph-iscsi-upstream]: https://docs.ceph.com/docs/master/rbd/iscsi-overview/\n[lp-bugs-charm-ceph-iscsi]: https://bugs.launchpad.net/charm-ceph-iscsi/+filebug\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fcharm-ceph-iscsi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenstack%2Fcharm-ceph-iscsi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenstack%2Fcharm-ceph-iscsi/lists"}