ceph-testcontainers-go

module
v0.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 8, 2026 License: MIT

README

ceph-testcontainers-go

Testcontainers for Go modules that run a real, disposable Ceph cluster for integration tests. The cluster runs the official Ceph daemons in containers: one MON, one MGR and two OSDs by default, plus RBD pools, CephFS filesystems with MDS daemons, and RGW gateways when you ask for them. Tests prepare and change the server side through typed Go APIs. Your application talks to the cluster with its own client: go-ceph, librados, librbd, libcephfs, the Ceph CLI or an S3 SDK.

The modules control Ceph through the CLIs inside the containers. They have no go-ceph, librados or cgo dependency and build with CGO_ENABLED=0. The Ceph daemons need no privileged mode, host disks, LVM or systemd: each OSD stores its data in a sparse BlueStore file inside its container by default. MemStore and memory-backed BlueStore are also available for faster disposable fixtures.

Releases follow semantic versioning. Before v1.0.0, a minor release may change the API without aliases for the old names. Final release notes are available with the published releases.

Documentation for a published release is available at its Git tag.

Packages

  • ceph: the cluster. MON, MGR and OSD topology, pools, Cephx identities, configuration and health.
    • ceph/diagnostics: read-only diagnostics reports, crash metadata and secret redaction for a cluster.
    • ceph/expect: pure evaluations of captured observations against a test's stated conditions, with mismatch explanations.
    • ceph/finalize: one ordered cleanup path with post-test checks, log and crash verification, a failure archive and Terminate.
  • rbd: RBD pools and namespaces, image watchers and locks, backup and restore.
    • rbd/mirror: rbd-mirror replication between two clusters.
      • rbd/mirror/expect: pure evaluations of captured receiver and image replay observations, with mismatch explanations.
  • cephfs: filesystems, MDS topology and data pools.
  • rgw: S3 and Swift gateways, users, tenants and quotas.
    • rgw/account: accounts, their quotas and root users.
    • rgw/placement: placement targets, storage classes and user default placement.
    • rgw/notification: persistent bucket notification queues of SUT-created topics.
    • rgw/multisite: realms, zonegroups and zones, period transfer, sync status and sync policy.
  • dashboard: the Ceph Dashboard of a cluster whose managers ship it, with an owned HTTPS listener and account, and the Object Gateway pages of one owned gateway.
  • fault: container pause, CPU limits, network delay, loss, rate, packet faults and endpoint interruption, zone-boundary profiles and damaged replicas on existing fixtures. fault/blockio prepares an owned disposable OSD main device for bounded delay and EIO faults.
  • override: reversible cluster-wide changes with restoration handles (blocklist, full ratios, MGR modules, OSD flags, debug levels, central configuration, messenger policy).
  • capture: opt-in packet capture on one container endpoint.

Every fixture package is a Testcontainers for Go module with one Run(ctx, image, opts...). In ceph and the service packages it returns a Container that embeds testcontainers.Container; the service packages build on ceph: their Container embeds *ceph.Container, and their options can be passed to ceph.Run together. The two-cluster fixtures start their daemons as Testcontainers containers on two existing clusters: rbd/mirror and cephfs/mirror return a *Container that owns the whole daemon cohort and embeds the first mirror daemon's testcontainers.Container, and rgw/multisite returns a *Fixture whose Source and Destination gateways are containers, while the Fixture itself embeds none. fault, override, capture, ceph/diagnostics and ceph/finalize start no fixture of their own; they act on or observe containers that already exist.

Requirements

  • Go 1.26 or later; use a patched toolchain. The repository selects Go 1.26.10 for its own checks. A consumer must select its own toolchain; the toolchain line of this repository does not set it.
  • A Docker engine that runs Linux containers. Docker Desktop works. Host networking has extra requirements, described in the host network guide.
  • Access to pull the Ceph image and the Ryuk image.

The default image is the published, pruned official Tentacle 20.2.4 aggregate, pinned to its AMD64/ARM64 index digest as ceph.DefaultImage. Explicit ceph.ImageSet selections use essential + client for ordinary RADOS/RBD and add CephFS, mirror/cache or RGW images only for those features. Runtime CI uses these dependency roles directly. Umbrella 21.2.x and Squid 19.2.x are supported too, with the differences listed in the releases guide.

Installation

go get github.com/JSYoo5B/ceph-testcontainers-go/ceph@latest

The repository is one Go module, so this makes every package available, rbd, cephfs and rgw included.

Quick start

package app_test

import (
	"testing"

	"github.com/JSYoo5B/ceph-testcontainers-go/ceph"
	"github.com/testcontainers/testcontainers-go"
)

func TestWithCeph(t *testing.T) {
	ctx := t.Context()
	cluster, err := ceph.Run(ctx, ceph.DefaultImage,
		ceph.WithClusterConfig(ceph.ClusterConfig{}.WithPools(ceph.PoolConfig{Name: "app"})),
	)
	testcontainers.CleanupContainer(t, cluster)
	if err != nil {
		t.Fatal(err)
	}
	observer, err := ceph.Observe(cluster)
	if err != nil {
		t.Fatal(err)
	}
	if err := observer.WaitForClean(ctx); err != nil {
		t.Fatal(err)
	}

	// Give a native client the cluster's ceph.conf and an admin keyring.
	cfg, err := cluster.ConnectionConfig(ctx)
	if err != nil {
		t.Fatal(err)
	}
	_ = cfg
}

The service packages start a cluster with their own defaults: rbd.Run creates an initialized RBD pool named rbd, cephfs.Run the filesystem tc-cephfs with one active MDS, and rgw.Run one S3 gateway with a generated test user. Like ceph.Run, each returns a partially started fixture together with its error, so register its cleanup before checking the error:

objects, err := rgw.Run(ctx, ceph.DefaultImage)
testcontainers.CleanupContainer(t, objects)
if err != nil {
	t.Fatal(err)
}
gateways, err := rgw.Gateways(ctx, objects.Container)
if err != nil {
	t.Fatal(err)
}
gateway := gateways[0] // AccessKey, SecretKey and Region
endpoint, err := gateway.S3Endpoint(ctx)
if err != nil {
	t.Fatal(err)
}

To serve several services from one cluster, pass their options to ceph.Run:

cluster, err := ceph.Run(ctx, ceph.DefaultImage,
	rbd.WithPools(ceph.PoolConfig{Name: "volumes"}),
	cephfs.WithFilesystems(cephfs.Config{Name: "shared"}),
	rgw.WithGateways(rgw.Config{Name: "s3"}),
)

Documentation

Guides for tasks that span packages:

  • API purpose and purpose tags: what the API is for, what each purpose tag means, and how an API declares its tags.
  • Ceph cluster configuration and Ceph cluster operations: the ceph concepts that span several APIs; each API is documented in its godoc.
  • Fault injection: stopping, pausing and disconnecting daemons and clients, delaying or dropping messages, fencing, full clusters and damaged replicas.
  • Host network: bridge and host networking, and connecting native clients from the test process.
  • Releases and images: supported Ceph releases, role images and image requirements.
  • Contexts and cleanup: how contexts bound calls, what each fixture owns, and how to restore temporary changes.
  • Running native commands: how to do anything the typed API does not cover with the Ceph CLIs inside the containers.
  • Fixtures for Messenger client tests: the profiles, daemon controls and differences for testing a Messenger client implementation against native daemons.
  • Classified errors: telling a refused request, a feature the release lacks, a missing image tool, an engine limit and a failed native command apart with errors.Is and errors.As.
  • Bug compatibility: the registered ceph_bug_<id> tags.

For contributors:

  • Testing: running and writing unit and integration tests.
  • CI: the GitHub Actions workflows and how to read a failing batch.
  • Preparing a release: the scope, evidence and publication checks for a candidate.
  • Bug compatibility tags: the policy for adding, selecting and retiring a ceph_bug_<id> tag.

ceph-testcontainers-images checks Ceph images against the requirements of these modules and publishes smaller role images (essential, client, cephfs, rbd-aux, rgw, and the aggregate all) extracted from the official images.

License

The modules are licensed under the MIT License, like Testcontainers for Go.

They do not contain or link Ceph. Tests pull the Ceph container images at run time and run the daemons and CLIs inside them; Ceph in those images is under its own licenses, mainly LGPL-2.1 and LGPL-3.0 with some GPL-2.0 parts. Any image a test selects, through the image argument of Run or an image option, keeps the licenses of whoever publishes it.

Directories

Path Synopsis
Package capture records packets in one container's network namespace with an opt-in packet-capture helper, retrieves the classic pcap file and checks its structure.
 Package capture records packets in one container's network namespace with an opt-in packet-capture helper, retrieves the classic pcap file and checks its structure.
Package ceph provisions disposable Ceph clusters using testcontainers-go.
 Package ceph provisions disposable Ceph clusters using testcontainers-go.
diagnostics
Package diagnostics collects read-only evidence from a Ceph fixture for a test to save or report: a diagnostics report of the containers, networks, log tails and fixed Ceph queries of a cluster (Collect), the Ceph crash metadata in its daemon containers (CollectCrashMetadata), and the redaction of the secrets that the cluster knows (Redact).
 Package diagnostics collects read-only evidence from a Ceph fixture for a test to save or report: a diagnostics report of the containers, networks, log tails and fixed Ceph queries of a cluster (Collect), the Ceph crash metadata in its daemon containers (CollectCrashMetadata), and the redaction of the secrets that the cluster knows (Redact).
expect
Package expect evaluates captured observations of a ceph cluster against the conditions a test states, and explains each mismatch.
 Package expect evaluates captured observations of a ceph cluster against the conditions a test states, and explains each mismatch.
finalize
Package finalize ends a test's dedicated Ceph cluster on one ordered cleanup path.
 Package finalize ends a test's dedicated Ceph cluster on one ordered cleanup path.
internal/evidence
Package evidence holds what package ceph, the diagnostics collectors and the test finalization share about collecting evidence from a cluster: the inventory of the containers and secrets that a cluster tracks, the selection of the containers that one collection reads, and the redaction and bounding of collected text.
 Package evidence holds what package ceph, the diagnostics collectors and the test finalization share about collecting evidence from a cluster: the inventory of the containers and secrets that a cluster tracks, the selection of the containers that one collection reads, and the redaction and bounding of collected text.
internal/evidencehook
Package evidencehook gives the diagnostics and finalize packages the parts of a ceph.Container that are not public API: the inventory of the containers, networks and secrets that it tracks, the ID that labels its containers and the description of a failed native command.
 Package evidencehook gives the diagnostics and finalize packages the parts of a ceph.Container that are not public API: the inventory of the containers, networks and secrets that it tracks, the ID that labels its containers and the description of a failed native command.
internal/monstore
Package monstore keeps the cluster-owned MON data volumes of a Ceph fixture: one store record per MON (State and Volume), its state machine from creation to release, the generations that mount it (StartGeneration, StopGeneration, ReplaceGeneration) and the address it pins.
 Package monstore keeps the cluster-owned MON data volumes of a Ceph fixture: one store record per MON (State and Volume), its state machine from creation to release, the generations that mount it (StartGeneration, StopGeneration, ReplaceGeneration) and the address it pins.
Package cephfs prepares CephFS server fixtures in disposable Ceph clusters: filesystems, their MDS topology and data pools.
 Package cephfs prepares CephFS server fixtures in disposable Ceph clusters: filesystems, their MDS topology and data pools.
expect
Package expect evaluates captured observations of a CephFS filesystem against the conditions a test states, and explains each mismatch.
 Package expect evaluates captured observations of a CephFS filesystem against the conditions a test states, and explains each mismatch.
internal/fsbase
Package fsbase is the foundation that package cephfs and its feature packages share for one filesystem: its identity (the cluster, the authoritative name and the native pool identity captured at creation), the liveness check, the admission lifetime of an operation, the command transport of the MGR volumes module with the readers more than one feature needs, and the native pool reads with the subvolume data-pool checks.
 Package fsbase is the foundation that package cephfs and its feature packages share for one filesystem: its identity (the cluster, the authoritative name and the native pool identity captured at creation), the liveness check, the admission lifetime of an operation, the command transport of the MGR volumes module with the readers more than one feature needs, and the native pool reads with the subvolume data-pool checks.
internal/fstest
Package fstest holds the unit-test fixtures that the tests of package cephfs and its feature packages share: the canned native output of one synthetic filesystem, a foundation core over it for the feature packages, which cannot construct a cephfs.Filesystem, and the assertions that an operation waits for a held admission gate without native effects.
 Package fstest holds the unit-test fixtures that the tests of package cephfs and its feature packages share: the canned native output of one synthetic filesystem, a foundation core over it for the feature packages, which cannot construct a cephfs.Filesystem, and the assertions that an operation waits for a held admission gate without native effects.
internal/mdsmap
Package mdsmap decodes the native global MDS map (`ceph fs dump`) for the MDS lifecycle decisions of package cephfs: that a filesystem is still cold, that a stopped MDS is gone from it, and how far its replacement got.
 Package mdsmap decodes the native global MDS map (`ceph fs dump`) for the MDS lifecycle decisions of package cephfs: that a filesystem is still cold, that a stopped MDS is gone from it, and how far its replacement got.
internal/volbase
Package volbase is the identity and the operation admission of the owned subvolumes and groups that package cephfs/subvolume creates, shared with the packages that act on subvolume handles, such as cephfs/quiesce.
 Package volbase is the identity and the operation admission of the owned subvolumes and groups that package cephfs/subvolume creates, shared with the packages that act on subvolume handles, such as cephfs/quiesce.
mirror
Package mirror mirrors CephFS snapshots of selected directories from a filesystem in one Ceph cluster to a filesystem in another, with native cephfs-mirror daemons: directory enrollment, peer management, MGR reassignment, process quiescence and typed readiness observation.
 Package mirror mirrors CephFS snapshots of selected directories from a filesystem in one Ceph cluster to a filesystem in another, with native cephfs-mirror daemons: directory enrollment, peer management, MGR reassignment, process quiescence and typed readiness observation.
quiesce
Package quiesce pauses the I/O of owned CephFS subvolumes as one native quiesce set, so that a test can take a consistent checkpoint while the application under test keeps its clients connected.
 Package quiesce pauses the I/O of owned CephFS subvolumes as one native quiesce set, so that a test can take a consistent checkpoint while the application under test keeps its clients connected.
session
Package session observes the client sessions of an existing CephFS filesystem and overrides its MDSMap session policy, so that a test can see a silent or frozen client evicted within seconds, a new client refused while open sessions keep working, or only clients that lack a required client feature refused and evicted.
 Package session observes the client sessions of an existing CephFS filesystem and overrides its MDSMap session policy, so that a test can see a silent or frozen client evicted within seconds, a new client refused while open sessions keep working, or only clients that lack a required client feature refused and evicted.
snapschedule
Package snapschedule adds snapshot schedules, with their retention, to directories of an existing CephFS filesystem through the MGR snap_schedule module, so that a test can check how its application handles scheduled snapshots and their pruning.
 Package snapschedule adds snapshot schedules, with their retention, to directories of an existing CephFS filesystem through the MGR snap_schedule module, so that a test can check how its application handles scheduled snapshots and their pruning.
subvolume
Package subvolume prepares the subvolume state of an existing CephFS filesystem: subvolume groups and subvolumes, their snapshots and clones, principals restricted to one subvolume, and directory pin policies of subvolumes and groups.
 Package subvolume prepares the subvolume state of an existing CephFS filesystem: subvolume groups and subvolumes, their snapshots and clones, principals restricted to one subvolume, and directory pin policies of subvolumes and groups.
Package dashboard prepares the Ceph Dashboard of an existing cluster as a collaborator for an application that consumes its REST API: an owned HTTPS listener with the caller's certificate, an owned account with one role, the endpoint of the active manager after an authenticated readiness check, and optionally the RGW backend of one owned gateway with a dedicated read-only RGW identity.
 Package dashboard prepares the Ceph Dashboard of an existing cluster as a collaborator for an application that consumes its REST API: an owned HTTPS listener with the caller's certificate, an owned account with one role, the endpoint of the active manager after an authenticated readiness check, and optionally the RGW backend of one owned gateway with a dedicated read-only RGW identity.
Package fault injects dedicated faults into an existing Ceph fixture.
 Package fault injects dedicated faults into an existing Ceph fixture.
blockio
Package blockio prepares disposable device-mapper storage for one BlueStore OSD and injects bounded main-device delay or EIO.
 Package blockio prepares disposable device-mapper storage for one BlueStore OSD and injects bounded main-device delay or EIO.
internal
apiinventory/catalogue
Package catalogue derives, stores and checks the package-scoped public API catalogues under internal/apiinventory/catalogues.
 Package catalogue derives, stores and checks the package-scoped public API catalogues under internal/apiinventory/catalogues.
blockio
Package blockio contains the device-mapper ownership and state primitives shared by block I/O fixtures and their integration checks.
 Package blockio contains the device-mapper ownership and state primitives shared by block I/O fixtures and their integration checks.
clusteraccess
Package clusteraccess gives tests one-line access to the context-taking topology accessors of ceph.Container and rgw.
 Package clusteraccess gives tests one-line access to the context-taking topology accessors of ceph.Container and rgw.
clustertest
Package clustertest holds unit-test fakes and assertions that package ceph, the service packages and internal/multicluster share.
 Package clustertest holds unit-test fakes and assertions that package ceph, the service packages and internal/multicluster share.
clusterutil
Package clusterutil holds small helpers that the cluster implementation and the service packages share: context-bounded locking, polling, operation errors and keyring parsing.
 Package clusterutil holds small helpers that the cluster implementation and the service packages share: context-bounded locking, polling, operation errors and keyring parsing.
consumerevidence
Package consumerevidence is an external-consumer example of three evidence recipes for Messenger client tests, written against the public API of this module only: the authentication first-failure bundle, the MGR transition receipt and the native MGR keyring gate of a short-ticket profile.
 Package consumerevidence is an external-consumer example of three evidence recipes for Messenger client tests, written against the public API of this module only: the authentication first-failure bundle, the MGR transition receipt and the native MGR keyring gate of a short-ticket profile.
consumerevidence/ipcfixture command
Command ipcfixture is a fixture process that a test drives over standard input and output, as a consumer whose fixture is a separate process without a testing.TB runs one.
 Command ipcfixture is a fixture process that a test drives over standard input and output, as a consumer whose fixture is a separate process without a testing.TB runs one.
dockerbridge
Package dockerbridge creates Testcontainers bridges whose allocated subnet can also accept endpoints restored to their original IP on older Engines.
 Package dockerbridge creates Testcontainers bridges whose allocated subnet can also accept endpoints restored to their original IP on older Engines.
faulthook
Package faulthook gives fault operations outside package ceph the parts of a ceph.Container that are not public API: the cluster's fault registry, its mutex and the private helpers that fault operations use.
 Package faulthook gives fault operations outside package ceph the parts of a ceph.Container that are not public API: the cluster's fault registry, its mutex and the private helpers that fault operations use.
hookreg
Package hookreg holds the hooks that package ceph registers for the rbd, cephfs and rgw packages, for the fault and override operations and for the diagnostics and finalize packages, and the hooks that package rgw registers for rgw/multisite.
 Package hookreg holds the hooks that package ceph registers for the rbd, cephfs and rgw packages, for the fault and override operations and for the diagnostics and finalize packages, and the hooks that package rgw registers for rgw/multisite.
integration/harness
multicluster
Package multicluster holds helpers shared by the cross-cluster fixtures of the rbd, cephfs and rgw packages: ownership of the extra containers and network attachments they create, cluster pair validation, CLI execution and bounded locking.
 Package multicluster holds helpers shared by the cross-cluster fixtures of the rbd, cephfs and rgw packages: ownership of the extra containers and network attachments they create, cluster pair validation, CLI execution and bounded locking.
naming
Package naming holds the name patterns the cluster and service packages accept for Ceph resources before passing them to a CLI.
 Package naming holds the name patterns the cluster and service packages accept for Ceph resources before passing them to a CLI.
nshelper
Package nshelper is shared by the fault and capture packages, whose helper containers join the network namespace of a target container: the error categories of their sentinels, the inspection of the target, the refusals of a target whose namespace a helper cannot join and the confinement of the helper.
 Package nshelper is shared by the fault and capture packages, whose helper containers join the network namespace of a target container: the error categories of their sentinels, the inspection of the target, the refusals of a target whose namespace a helper cannot join and the confinement of the helper.
overridehook
Package overridehook gives the override package the parts of a ceph.Container that are not public API: the cluster's registry of held overrides, its mutex and one typed operation per native command.
 Package overridehook gives the override package the parts of a ceph.Container that are not public API: the cluster's registry of held overrides, its mutex and one typed operation per native command.
pcapfile
Package pcapfile checks the structure of a classic pcap capture file with bounded reads.
 Package pcapfile checks the structure of a classic pcap capture file with bounded reads.
rgwhook
Package rgwhook gives rgw/multisite a host port reserved for a gateway before it starts, which needs the gateway start of package rgw and is not public API.
 Package rgwhook gives rgw/multisite a host port reserved for a gateway before it starts, which needs the gateway start of package rgw and is not public API.
servicehook
Package servicehook gives the rbd, cephfs and rgw packages the parts of a ceph.Container that are not public API, such as its mutex and Run-time provisioning.
 Package servicehook gives the rbd, cephfs and rgw packages the parts of a ceph.Container that are not public API, such as its mutex and Run-time provisioning.
strictjson
Package strictjson reads native Ceph JSON without the silent choices of encoding/json.
 Package strictjson reads native Ceph JSON without the silent choices of encoding/json.
supervised
Package supervised runs a command inside a container under a Python supervisor that bounds its run time and output, and that a canceled caller can stop without leaving the command behind.
 Package supervised runs a command inside a container under a Python supervisor that bounds its run time and output, and that a canceled caller can stop without leaving the command behind.
testhelper
Package testhelper gives unit tests of the ceph, rbd, cephfs, rgw, fault, override and internal packages the synthetic cluster constructor, the privileged state accessors and the registry snapshots they need.
 Package testhelper gives unit tests of the ceph, rbd, cephfs, rgw, fault, override and internal packages the synthetic cluster constructor, the privileged state accessors and the registry snapshots they need.
tools/apinaming command
Command apinaming maintains the package-scoped API catalogues under internal/apiinventory/catalogues.
 Command apinaming maintains the package-scoped API catalogues under internal/apiinventory/catalogues.
tools/batchselect command
Command batchselect reports which test batches of one package a change can affect.
 Command batchselect reports which test batches of one package a change can affect.
tools/lintcalibration command
Command lintcalibration runs the metric linters of issue #226 (cyclop, dupl, funlen, gocognit) through golangci-lint with a report-only configuration that keeps every diagnostic, and prints them grouped by source location.
 Command lintcalibration runs the metric linters of issue #226 (cyclop, dupl, funlen, gocognit) through golangci-lint with a report-only configuration that keeps every diagnostic, and prints them grouped by source location.
tools/messengercases command
Command messengercases indexes top-level integration test declarations and their literal log markers.
 Command messengercases indexes top-level integration test declarations and their literal log markers.
tools/structmetrics command
Command structmetrics reports a fixed structural measurement of named struct types: declared methods (split by exported-name and private) and direct fields per type, for chosen package directories of one source snapshot, and the per-type difference between a base and a head snapshot.
 Command structmetrics reports a fixed structural measurement of named struct types: declared methods (split by exported-name and private) and direct fields per type, for chosen package directories of one source snapshot, and the per-type difference between a base and a head snapshot.
tools/tagcatalog command
Command tagcatalog reads test declarations and build expressions without importing or executing packages from the repository it inspects.
 Command tagcatalog reads test declarations and build expressions without importing or executing packages from the repository it inspects.
tools/testdoublecheck command
Command testdoublecheck checks, without Docker, that every test double and test-only access point of the module says what it is, next to its declaration.
 Command testdoublecheck checks, without Docker, that every test double and test-only access point of the module says what it is, next to its declaration.
tools/testsupportcheck command
Command testsupportcheck checks, without Docker, the import, seam and declaration boundary of the repository's test-only code: which packages may import the shared test helpers, which files may read the unit seam, and which declarations may appear in non-test files.
 Command testsupportcheck checks, without Docker, the import, seam and declaration boundary of the repository's test-only code: which packages may import the shared test helpers, which files may read the unit seam, and which declarations may appear in non-test files.
watch
Package watch is the polling producer behind the public Watch APIs.
 Package watch is the polling producer behind the public Watch APIs.
Package override changes one cluster-wide setting of a ceph.Container for a while and puts it back.
 Package override changes one cluster-wide setting of a ceph.Container for a while and puts it back.
rbd
Package rbd prepares RBD server fixtures in disposable Ceph clusters: initialized image pools, namespaces and full or incremental backup transport.
 Package rbd prepares RBD server fixtures in disposable Ceph clusters: initialized image pools, namespaces and full or incremental backup transport.
internal/resourcename
Package resourcename validates the pool, namespace and image names accepted by standalone RBD operations.
 Package resourcename validates the pool, namespace and image names accepted by standalone RBD operations.
mirror
Package mirror connects two Ceph clusters with native RBD mirroring: setup CLI containers, one-way pool or image mirroring in snapshot or journal mode, any number of rbd-mirror receiver daemons, and typed readiness observation.
 Package mirror connects two Ceph clusters with native RBD mirroring: setup CLI containers, one-way pool or image mirroring in snapshot or journal mode, any number of rbd-mirror receiver daemons, and typed readiness observation.
mirror/expect
Package expect evaluates captured observations of an rbd-mirror link against the conditions a test states, and explains each mismatch.
 Package expect evaluates captured observations of an rbd-mirror link against the conditions a test states, and explains each mismatch.
rgw
Package rgw prepares RADOS Gateway fixtures in disposable Ceph clusters: gateways, S3 users with tenants, Admin Ops capabilities, quotas, S3 key rotation, STS roles, reversible rate limits and storage counters, and native TLS with certificate replacement.
 Package rgw prepares RADOS Gateway fixtures in disposable Ceph clusters: gateways, S3 users with tenants, Admin Ops capabilities, quotas, S3 key rotation, STS roles, reversible rate limits and storage counters, and native TLS with certificate replacement.
account
Package account prepares native RGW accounts through an existing gateway: fresh accounts with their tenant, limits and quotas, whose root users are created by rgw.Gateway.CreateUser with rgw.UserConfig.Account.
 Package account prepares native RGW accounts through an existing gateway: fresh accounts with their tenant, limits and quotas, whose root users are created by rgw.Gateway.CreateUser with rgw.UserConfig.Account.
internal/gwbase
Package gwbase is the foundation that package rgw and its feature packages (rgw/account, rgw/placement, rgw/notification and rgw/multisite) share for one gateway and the resources created through it: the gateway identity (its cluster, name, configured scope, listener and container), the admin command transport, the selection of the gateway that runs a resource handle's operations, the native runtime scope of a running gateway, and the private state of owned users and accounts.
 Package gwbase is the foundation that package rgw and its feature packages (rgw/account, rgw/placement, rgw/notification and rgw/multisite) share for one gateway and the resources created through it: the gateway identity (its cluster, name, configured scope, listener and container), the admin command transport, the selection of the gateway that runs a resource handle's operations, the native runtime scope of a running gateway, and the private state of owned users and accounts.
internal/gwtest
Package gwtest holds the unit-test fixtures that the tests of package rgw and its feature packages share: the supervisor framing of radosgw-admin calls, canned native user documents, a synthetic cluster, a foundation core over a gateway container for the feature packages, which cannot construct an rgw.Gateway, and small models of the native zone, placement, period, user and account state that the typed operations read and change.
 Package gwtest holds the unit-test fixtures that the tests of package rgw and its feature packages share: the supervisor framing of radosgw-admin calls, canned native user documents, a synthetic cluster, a foundation core over a gateway container for the feature packages, which cannot construct an rgw.Gateway, and small models of the native zone, placement, period, user and account state that the typed operations read and change.
multisite
Package multisite orchestrates RGW multisite fixtures across independent Ceph clusters: one realm, zones and zonegroups, period transfer, sync status and sync policies.
 Package multisite orchestrates RGW multisite fixtures across independent Ceph clusters: one realm, zones and zonegroups, period transfer, sync status and sync policies.
notification
Package notification observes the persistent queue of one RGW bucket notification topic through an existing gateway: the topic's native identity and delivery limits, its queue statistics and an optional bounded sample of the pending entries.
 Package notification observes the persistent queue of one RGW bucket notification topic through an existing gateway: the topic's native identity and delivery limits, its queue statistics and an optional bounded sample of the pending entries.
placement
Package placement prepares bucket placement targets and storage classes through an existing gateway: a fresh, non-default placement target with its index, multipart and per-class data pools, its activation in a standalone gateway or a realm period, and a user's default placement.
 Package placement prepares bucket placement targets and storage classes through an existing gateway: a fresh, non-default placement target with its index, multipart and per-class data pools, its activation in a standalone gateway or a realm period, and a user's default placement.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.