crate.operator package

Subpackages

• crate.operator.handlers package
  • Submodules
    • crate.operator.handlers.handle_create_cratedb module
      • create_cratedb()
    • crate.operator.handlers.handle_create_grand_central module
      • create_grand_central()
    • crate.operator.handlers.handle_notify_external_ip_changed module
      • external_ip_changed()
    • crate.operator.handlers.handle_ping_cratedb_status module
      • ping_cratedb_status()
    • crate.operator.handlers.handle_restore_backup module
      • register_after_restore_handlers()
      • register_before_restore_handlers()
      • register_restore_handlers()
      • restore_backup()
    • crate.operator.handlers.handle_update_allowed_cidrs module
      • update_service_allowed_cidrs()
    • crate.operator.handlers.handle_update_backup_schedule module
      • update_backup_schedule()
    • crate.operator.handlers.handle_update_cratedb module
      • get_backoff()
      • register_after_update_handlers()
      • register_before_update_handlers()
      • register_change_compute_handlers()
      • register_restart_handlers()
      • register_scale_handlers()
      • register_storage_expansion_handlers()
      • register_upgrade_handlers()
      • update_cratedb()
    • crate.operator.handlers.handle_update_user_password_secret module
      • update_user_password_secret()
    • crate.operator.handlers.handle_upgrade_grand_central module
      • upgrade_grand_central()
  • Module contents
• crate.operator.utils package
  • Subpackages
    • crate.operator.utils.crate package
      • Submodules
      • Module contents
  • Submodules
    • crate.operator.utils.crd module
      • has_compute_changed()
    • crate.operator.utils.formatting module
      • b64decode()
      • b64encode()
      • convert_to_bytes()
      • encode_decode_wrapper()
      • format_bitmath()
    • crate.operator.utils.k8s_api_client module
      • GlobalApiClient
    • crate.operator.utils.kopf module
      • Notification
      • StateBasedSubHandler
      • send_webhook_notification()
      • subhandler_partial()
    • crate.operator.utils.kubeapi module
      • call_kubeapi()
      • ensure_user_password_label()
      • get_host()
      • get_service_public_hostname()
      • get_system_user_password()
      • resolve_secret_key_ref()
    • crate.operator.utils.notifications module
      • FlushNotificationsSubHandler
      • send_operation_progress_notification()
    • crate.operator.utils.secrets module
      • gen_password()
      • get_image_pull_secrets()
    • crate.operator.utils.typing module
      • SecretKeyRef
      • SecretKeyRefContainer
    • crate.operator.utils.version module
      • CrateVersion
  • Module contents
    • quorum()

Submodules

• crate.operator.backup module
  • CreateBackupsSubHandler
    • CreateBackupsSubHandler.handle()
  • create_backups()
  • get_backup_cronjob()
  • get_backup_env()
  • get_backup_metrics_exporter()
  • get_webhook_env()
  • update_backup_schedule_in_cronjob()
• crate.operator.bootstrap module
  • CreateUsersSubHandler
    • CreateUsersSubHandler.handle()
  • bootstrap_gc_admin_user()
  • bootstrap_system_user()
  • bootstrap_users()
  • create_users()
• crate.operator.change_compute module
  • AfterChangeComputeSubHandler
    • AfterChangeComputeSubHandler.handle()
  • ChangeComputeSubHandler
    • ChangeComputeSubHandler.handle()
  • change_cluster_compute()
  • generate_body_patch()
  • generate_change_compute_payload()
• crate.operator.config module
  • Config
    • Config.AFTER_UPDATE_TIMEOUT
    • Config.BEFORE_UPDATE_TIMEOUT
    • Config.BOOTSTRAP_RETRY_DELAY
    • Config.BOOTSTRAP_TIMEOUT
    • Config.CLOUD_PROVIDER
    • Config.CLUSTER_BACKUP_IMAGE
    • Config.CLUSTER_UPDATE_TIMEOUT
    • Config.CRATEDB_STATUS_CHECK_INTERVAL
    • Config.DEBUG_VOLUME_SIZE
    • Config.DEBUG_VOLUME_STORAGE_CLASS
    • Config.EXPAND_VOLUME_TIMEOUT
    • Config.GATEWAY_SETTINGS_DATA_NODES_VERSION
    • Config.GC_SENTRY_DSN
    • Config.HEALTH_CHECK_RETRY_DELAY
    • Config.IMAGE_PULL_SECRETS
    • Config.JMX_EXPORTER_VERSION
    • Config.JOBS_TABLE
    • Config.KUBECONFIG
    • Config.LOG_LEVEL
    • Config.NO_DOWNTIME_STORAGE_EXPANSION
    • Config.PARALLEL_TESTING
    • Config.PROMETHEUS_PORT
    • Config.RESTORE_BACKUP_SECRET_NAME
    • Config.RESTORE_BACKUP_TIMEOUT
    • Config.RE_ENABLING_CRONJOB_DELAY
    • Config.ROLLING_RESTART_TIMEOUT
    • Config.SCALING_TIMEOUT
    • Config.SQL_EXPORTER_IMAGE
    • Config.TESTING
    • Config.WEBHOOK_PASSWORD
    • Config.WEBHOOK_URL
    • Config.WEBHOOK_USERNAME
    • Config.env()
    • Config.load()
  • config
• crate.operator.constants module
  • CloudProvider
    • CloudProvider.AWS
    • CloudProvider.AZURE
    • CloudProvider.GCP
  • Nodepool
    • Nodepool.DEDICATED
    • Nodepool.SHARED
  • Port
    • Port.HTTP
    • Port.JMX
    • Port.POSTGRES
    • Port.PROMETHEUS
    • Port.TRANSPORT
  • SnapshotRestoreType
    • SnapshotRestoreType.ALL
    • SnapshotRestoreType.METADATA
    • SnapshotRestoreType.PARTITIONS
    • SnapshotRestoreType.SECTIONS
    • SnapshotRestoreType.TABLES
• crate.operator.cratedb module
  • are_snapshots_in_progress()
  • connection_factory()
  • create_user()
  • get_cluster_admin_username()
  • get_cluster_settings()
  • get_connection()
  • get_healthiness()
  • get_number_of_nodes()
  • is_cluster_healthy()
  • reset_cluster_setting()
  • set_cluster_setting()
  • update_user()
• crate.operator.create module
  • CreateServicesSubHandler
    • CreateServicesSubHandler.handle()
  • CreateSqlExporterConfigSubHandler
    • CreateSqlExporterConfigSubHandler.handle()
  • CreateStatefulsetSubHandler
    • CreateStatefulsetSubHandler.handle()
  • CreateSystemUserSubHandler
    • CreateSystemUserSubHandler.handle()
  • create_services()
  • create_sql_exporter_config()
  • create_statefulset()
  • create_system_user()
  • get_cluster_resource_limits()
  • get_cluster_resource_requests()
  • get_data_service()
  • get_discovery_service()
  • get_gc_user_secret()
  • get_owner_references()
  • get_sql_exporter_config()
  • get_statefulset()
  • get_statefulset_affinity()
  • get_statefulset_containers()
  • get_statefulset_crate_command()
  • get_statefulset_crate_env()
  • get_statefulset_crate_env_java_opts()
  • get_statefulset_crate_volume_mounts()
  • get_statefulset_env_crate_heap()
  • get_statefulset_init_containers()
  • get_statefulset_pvc()
  • get_statefulset_volumes()
  • get_system_user_secret()
  • get_tolerations()
  • get_topology_spread()
  • is_shared_resources_cluster()
  • recreate_services()
• crate.operator.edge module
  • notify_service_ip()
• crate.operator.exceptions module
  • ConfigurationError
  • SubHandlerFailedDependencyError
• crate.operator.expand_volume module
  • ExpandVolumeSubHandler
    • ExpandVolumeSubHandler.handle()
  • expand_volume()
• crate.operator.grand_central module
  • create_grand_central_backend()
  • create_grand_central_user()
  • get_grand_central_deployment()
  • get_grand_central_ingress()
  • get_grand_central_labels()
  • get_grand_central_service()
  • read_grand_central_deployment()
  • read_grand_central_ingress()
  • update_grand_central_deployment_image()
• crate.operator.kube_auth module
  • login_via_kubernetes_asyncio()
• crate.operator.main module
  • annotation_filter()
  • cluster_create()
  • cluster_restore()
  • cluster_update()
  • enable_cronjob_after_delay()
  • grand_central_create()
  • grand_central_upgrade()
  • login()
  • ping_cratedb()
  • raise_on_namespace_terminating()
  • secret_update()
  • service_backup_schedule_update()
  • service_cidr_changes()
  • service_external_ip_update()
  • startup()
• crate.operator.operations module
  • AfterClusterUpdateSubHandler
    • AfterClusterUpdateSubHandler.handle()
  • BeforeClusterUpdateSubHandler
    • BeforeClusterUpdateSubHandler.handle()
  • RestartSubHandler
    • RestartSubHandler.handle()
  • StartClusterSubHandler
    • StartClusterSubHandler.handle()
  • SuspendClusterSubHandler
    • SuspendClusterSubHandler.handle()
  • add_sql_exporter_collectors_to_configmap()
  • check_all_data_nodes_gone()
  • check_all_data_nodes_present()
  • check_backup_metrics_pod_gone()
  • check_cluster_healthy()
  • delete_lb_service()
  • ensure_cronjob_reenabled()
  • get_cratedb_resource()
  • get_lb_service()
  • get_master_nodes_names()
  • get_namespace_resource()
  • get_pods_in_cluster()
  • get_pods_in_deployment()
  • get_pods_in_statefulset()
  • get_pvcs_in_namespace()
  • get_sql_exporter_collectors()
  • get_total_nodes_count()
  • is_lb_service_present()
  • is_lb_service_ready()
  • is_namespace_terminating()
  • restart_cluster()
  • scale_backup_metrics_deployment()
  • set_cronjob_delay()
  • suspend_or_start_cluster()
  • update_deployment_replicas()
  • update_statefulset_replicas()
• crate.operator.prometheus module
  • ClusterCollector
    • ClusterCollector.collect()
  • PrometheusClusterStatus
    • PrometheusClusterStatus.GREEN
    • PrometheusClusterStatus.RED
    • PrometheusClusterStatus.UNREACHABLE
    • PrometheusClusterStatus.YELLOW
  • report_cluster_status()
• crate.operator.restore_backup module
  • AfterRestoreBackupSubHandler
    • AfterRestoreBackupSubHandler.handle()
  • BeforeRestoreBackupSubHandler
    • BeforeRestoreBackupSubHandler.handle()
  • ResetSnapshotSubHandler
    • ResetSnapshotSubHandler.handle()
  • RestoreAll
    • RestoreAll.get_restore_keyword()
    • RestoreAll.validate_restore_complete()
  • RestoreBackupSubHandler
    • RestoreBackupSubHandler.handle()
  • RestoreDataSections
    • RestoreDataSections.DATA_SECTION_TABLES
    • RestoreDataSections.get_restore_keyword()
    • RestoreDataSections.validate_restore_complete()
  • RestoreMetadata
    • RestoreMetadata.get_restore_keyword()
    • RestoreMetadata.validate_restore_complete()
  • RestorePartitions
    • RestorePartitions.get_restore_keyword()
    • RestorePartitions.validate_restore_complete()
  • RestoreSystemUserPasswordSubHandler
    • RestoreSystemUserPasswordSubHandler.handle()
  • RestoreTables
    • RestoreTables.get_restore_keyword()
    • RestoreTables.validate_restore_complete()
  • RestoreType
    • RestoreType.create()
    • RestoreType.get_restore_keyword()
    • RestoreType.register_subclass()
    • RestoreType.subclasses
    • RestoreType.validate_restore_complete()
  • SendSuccessNotificationSubHandler
    • SendSuccessNotificationSubHandler.handle()
  • ValidateRestoreCompleteSubHandler
    • ValidateRestoreCompleteSubHandler.handle()
  • drop_repository()
  • ensure_no_restore_in_progress()
  • get_crash_pod_name()
  • get_crash_scheme()
  • get_snapshot_tables()
  • get_source_backup_repository_data()
  • is_valid_snapshot()
  • run_crash_command()
  • shards_recovery_in_progress()
  • update_cratedb_admin_username_in_cratedb()
• crate.operator.scale module
  • ScaleSubHandler
    • ScaleSubHandler.handle()
  • check_for_deallocation()
  • check_nodes_present_or_gone()
  • deallocate_nodes()
  • get_container()
  • parse_replicas()
  • patch_command()
  • reset_allocation()
  • scale_cluster()
  • scale_cluster_patch_total_nodes()
  • update_statefulset()
• crate.operator.update_user_password module
  • update_user_password()
• crate.operator.upgrade module
  • AfterUpgradeSubHandler
    • AfterUpgradeSubHandler.handle()
  • UpgradeSubHandler
    • UpgradeSubHandler.handle()
  • update_statefulset()
  • upgrade_cluster()
  • upgrade_command()
• crate.operator.webhooks module
  • WebhookAction
    • WebhookAction.ALLOWED_CIDR_UPDATE
    • WebhookAction.BACKUP_SCHEDULE_UPDATE
    • WebhookAction.CHANGE_COMPUTE
    • WebhookAction.CREATE
    • WebhookAction.EXPAND_STORAGE
    • WebhookAction.PASSWORD_UPDATE
    • WebhookAction.RESTORE_SNAPSHOT
    • WebhookAction.SCALE
    • WebhookAction.SUSPEND
    • WebhookAction.UNKNOWN
    • WebhookAction.UPGRADE
    • WebhookAction.for_diff()
  • WebhookAdminUsernameChangedPayload
    • WebhookAdminUsernameChangedPayload.admin_username
  • WebhookBackupScheduleUpdatePayload
    • WebhookBackupScheduleUpdatePayload.backup_schedule
  • WebhookChangeComputePayload
    • WebhookChangeComputePayload.new_cpu_limit
    • WebhookChangeComputePayload.new_cpu_request
    • WebhookChangeComputePayload.new_heap_ratio
    • WebhookChangeComputePayload.new_memory_limit
    • WebhookChangeComputePayload.new_memory_request
    • WebhookChangeComputePayload.new_nodepool
    • WebhookChangeComputePayload.old_cpu_limit
    • WebhookChangeComputePayload.old_cpu_request
    • WebhookChangeComputePayload.old_heap_ratio
    • WebhookChangeComputePayload.old_memory_limit
    • WebhookChangeComputePayload.old_memory_request
    • WebhookChangeComputePayload.old_nodepool
  • WebhookClient
    • WebhookClient.configure()
    • WebhookClient.configured
    • WebhookClient.send_notification()
  • WebhookClusterHealthPayload
    • WebhookClusterHealthPayload.status
  • WebhookEvent
    • WebhookEvent.ADMIN_USERNAME_CHANGED
    • WebhookEvent.BACKUP_SCHEDULE_UPDATE
    • WebhookEvent.COMPUTE_CHANGED
    • WebhookEvent.DELAY
    • WebhookEvent.FEEDBACK
    • WebhookEvent.HEALTH
    • WebhookEvent.INFO_CHANGED
    • WebhookEvent.SCALE
    • WebhookEvent.SNAPSHOT
    • WebhookEvent.UPGRADE
  • WebhookFeedbackPayload
    • WebhookFeedbackPayload.action
    • WebhookFeedbackPayload.message
    • WebhookFeedbackPayload.operation
  • WebhookInfoChangedPayload
    • WebhookInfoChangedPayload.external_ip
  • WebhookOperation
    • WebhookOperation.CREATE
    • WebhookOperation.UPDATE
  • WebhookPayload
    • WebhookPayload.admin_username_changed_data
    • WebhookPayload.backup_schedule_data
    • WebhookPayload.cluster
    • WebhookPayload.compute_changed_data
    • WebhookPayload.event
    • WebhookPayload.feedback_data
    • WebhookPayload.health_data
    • WebhookPayload.info_data
    • WebhookPayload.namespace
    • WebhookPayload.scale_data
    • WebhookPayload.status
    • WebhookPayload.temporary_failure_data
    • WebhookPayload.upgrade_data
  • WebhookScaleNodePayload
    • WebhookScaleNodePayload.name
    • WebhookScaleNodePayload.replicas
  • WebhookScalePayload
    • WebhookScalePayload.new_data_replicas
    • WebhookScalePayload.new_master_replicas
    • WebhookScalePayload.old_data_replicas
    • WebhookScalePayload.old_master_replicas
  • WebhookStatus
    • WebhookStatus.FAILURE
    • WebhookStatus.IN_PROGRESS
    • WebhookStatus.SUCCESS
    • WebhookStatus.TEMPORARY_FAILURE
  • WebhookSubPayload
  • WebhookTemporaryFailurePayload
    • WebhookTemporaryFailurePayload.reason
  • WebhookUpgradePayload
    • WebhookUpgradePayload.new_registry
    • WebhookUpgradePayload.new_version
    • WebhookUpgradePayload.old_registry
    • WebhookUpgradePayload.old_version

Module contents