MCPcopy
hub / github.com/rook/rook

github.com/rook/rook @v1.20.1 sqlite

repository ↗ · DeepWiki ↗ · release v1.20.1 ↗
6,280 symbols 27,176 edges 701 files 2,810 documented · 45%
README

Rook

CNCF Status GitHub release Docker Pulls Go Report Card OpenSSF Scorecard CII Best Practices Security scanning Slack Twitter Follow

What is Rook?

Rook is an open source cloud-native storage orchestrator for Kubernetes, providing the platform, framework, and support for Ceph storage to natively integrate with Kubernetes.

Ceph is a distributed storage system that provides file, block and object storage and is deployed in large scale production clusters.

Rook automates deployment and management of Ceph to provide self-managing, self-scaling, and self-healing storage services. The Rook operator does this by building on Kubernetes resources to deploy, configure, provision, scale, upgrade, and monitor Ceph.

The status of the Ceph storage provider is Stable. Features and improvements will be planned for many future versions. Upgrades between versions are provided to ensure backward compatibility between releases.

Rook is hosted by the Cloud Native Computing Foundation (CNCF) as a graduated level project. If you are a company that wants to help shape the evolution of technologies that are container-packaged, dynamically-scheduled and microservices-oriented, consider joining the CNCF. For details about who's involved and how Rook plays a role, read the CNCF announcement.

Getting Started and Documentation

For installation, deployment, and administration, see our Documentation and QuickStart Guide.

Contributing

We welcome contributions. See Contributing to get started.

Report a Bug

For filing bugs, suggesting improvements, or requesting new features, please open an issue.

Reporting Security Vulnerabilities

If you find a vulnerability or a potential vulnerability in Rook please let us know immediately at cncf-rook-security@lists.cncf.io. We'll send a confirmation email to acknowledge your report, and we'll send an additional email when we've identified the issues positively or negatively.

For further details, please see the complete security release process.

Contact

Please use the following to reach members of the community:

Community Meeting

A regular community meeting takes place the 2nd Tuesday of every month at 9:00 AM PT (Pacific Time). Convert to your local timezone.

Any changes to the meeting schedule will be added to the agenda doc and posted to Slack #announcements.

Anyone who wants to discuss the direction of the project, design and implementation reviews, or general questions with the broader community is welcome and encouraged to join.

Official Releases

Official releases of Rook can be found on the releases page. Please note that it is strongly recommended that you use official releases of Rook, as unreleased versions from the master branch are subject to changes and incompatibilities that will not be supported in the official releases. Builds from the master branch can have functionality changed and even removed at any time without compatibility support and without prior notice.

Licensing

Rook is under the Apache 2.0 license.

FOSSA Status

Extension points exported contracts — how you extend this code

GenericInformer (Interface)
GenericInformer is type of SharedIndexInformer which will locate and delegate to other sharedInformers based on type [20 …
pkg/client/informers/externalversions/generic.go
Executor (Interface)
Executor is the main interface for all the exec commands [2 implementers]
pkg/util/exec/exec.go
Logger (Interface)
Logger defines the log types that this library will use for outputting status information to the user. Because this libr [1 …
pkg/daemon/multus/util.go
MockDoType (FuncType)
MockDoType is a custom type that allows setting the function that our Mock Do func will run instead
pkg/operator/ceph/object/admin_mock.go
CephManifests (Interface)
(no doc) [2 implementers]
tests/framework/installer/ceph_manifests.go
CephRBDMirrorInformer (Interface)
CephRBDMirrorInformer provides access to a shared informer and lister for CephRBDMirrors. [20 implementers]
pkg/client/informers/externalversions/ceph.rook.io/v1/cephrbdmirror.go
RetryFunc (FuncType)
RetryFunc is a function that returns true when it is done and it should be retried no longer. It should return error if
pkg/util/retry.go
CmdReporterInterface (Interface)
(no doc) [2 implementers]
pkg/operator/k8sutil/cmdreporter/cmdreporter.go

Core symbols most depended-on inside this repo

Equal
called by 3017
pkg/daemon/multus/resources.go
Infof
called by 1099
pkg/daemon/multus/util.go
Run
called by 1051
pkg/operator/k8sutil/cmdreporter/cmdreporter.go
Get
called by 741
pkg/client/listers/ceph.rook.io/v1/cephnfs.go
Run
called by 619
pkg/daemon/multus/statemachine.go
Error
called by 443
pkg/util/exec/error.go
Create
called by 307
pkg/client/clientset/versioned/typed/ceph.rook.io/v1/cephnfs.go
NamespacedInfo
called by 303
pkg/util/log/log.go

Shape

Function 2,861
Method 2,524
Struct 663
Interface 166
TypeAlias 49
Class 11
FuncType 6

Languages

Go97%
Python3%
TypeScript1%

Modules by API surface

pkg/apis/ceph.rook.io/v1/zz_generated.deepcopy.go486 symbols
pkg/apis/ceph.rook.io/v1/types.go236 symbols
tests/framework/utils/k8s_helper.go98 symbols
tests/framework/installer/ceph_manifests.go68 symbols
deploy/examples/external/create-external-cluster-resources.py68 symbols
deploy/examples/create-external-cluster-resources.py68 symbols
pkg/operator/ceph/object/objectstore.go55 symbols
pkg/operator/ceph/cluster/mon/mon.go54 symbols
pkg/operator/ceph/controller/spec.go48 symbols
pkg/operator/ceph/cluster/osd/osd.go45 symbols
pkg/operator/ceph/object/spec.go42 symbols
pkg/client/informers/externalversions/ceph.rook.io/v1/interface.go41 symbols

Dependencies from manifests, versioned

emperror.dev/errorsv0.8.1 · 1×
github.com/Azure/azure-sdk-for-go/sdk/azcorev1.16.0 · 1×
github.com/Azure/azure-sdk-for-go/sdk/azidentityv1.8.0 · 1×
github.com/Azure/azure-sdk-for-go/sdk/internalv1.10.0 · 1×
github.com/Azure/azure-sdk-for-go/sdk/keyvault/azsecretsv0.12.0 · 1×
github.com/Azure/azure-sdk-for-go/sdk/keyvault/internalv0.7.1 · 1×
github.com/Azure/go-ansitermv0.0.0-2023012417243 · 1×
github.com/AzureAD/microsoft-authentication-library-for-gov1.3.2 · 1×
github.com/IBM/keyprotect-go-clientv0.16.0 · 1×
github.com/ansel1/merryv1.8.1 · 1×
github.com/ansel1/merry/v2v2.2.2 · 1×
github.com/aws/aws-sdk-go-v2v1.41.7 · 1×

For agents

$ claude mcp add rook \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact