Directories
¶
| Path | Synopsis |
|---|---|
|
api
|
|
|
v1alpha1
Package v1alpha1 contains the first public API for the Ptah operator.
|
Package v1alpha1 contains the first public API for the Ptah operator. |
|
cmd
|
|
|
kubectl-ptah
command
Command kubectl-ptah reads what the Ptah operator stored.
|
Command kubectl-ptah reads what the Ptah operator stored. |
|
manager
command
|
|
|
ptah-cert-rotator
command
|
|
|
ptah-crd-manager
command
|
|
|
ptah-runner
command
|
|
|
demo
|
|
|
cmd/record
command
Command record runs the demonstration scenarios against a live lab and writes what happened.
|
Command record runs the demonstration scenarios against a live lab and writes what happened. |
|
reference/v1
Package catalog is the storefront's reference data: the tables whose rows the application reads and never writes, declared beside the tables themselves.
|
Package catalog is the storefront's reference data: the tables whose rows the application reads and never writes, declared beside the tables themselves. |
|
reference/v2
Package catalog is the storefront's reference data: the tables whose rows the application reads and never writes, declared beside the tables themselves.
|
Package catalog is the storefront's reference data: the tables whose rows the application reads and never writes, declared beside the tables themselves. |
|
reference/v3
Package catalog is the storefront's reference data: the tables whose rows the application reads and never writes, declared beside the tables themselves.
|
Package catalog is the storefront's reference data: the tables whose rows the application reads and never writes, declared beside the tables themselves. |
|
acceptancecoverage
command
Package main derives the acceptance coverage table from the catalogs and the driver, rather than from a list written beside them.
|
Package main derives the acceptance coverage table from the catalogs and the driver, rather than from a list written beside them. |
|
capacity
command
Command capacity measures what the operator costs under a declared workload.
|
Command capacity measures what the operator costs under a declared workload. |
|
capacityplancheck
command
capacityplancheck applies the operator's SQL safety classification to a capacity fixture before the native verifier executes it.
|
capacityplancheck applies the operator's SQL safety classification to a capacity fixture before the native verifier executes it. |
|
chartpackage
command
|
|
|
chartpolicies
command
Command chartpolicies generates the chart templates that ship the admission policies defined in Go.
|
Command chartpolicies generates the chart templates that ship the admission policies defined in Go. |
|
crdreference
command
crdreference renders the field reference for every custom resource this operator ships.
|
crdreference renders the field reference for every custom resource this operator ships. |
|
crdschemadigest
command
|
|
|
crdschemahistory
Package crdschemahistory verifies that the generated CRD schema identity advances monotonically relative to an exact Git commit.
|
Package crdschemahistory verifies that the generated CRD schema identity advances monotonically relative to an exact Git commit. |
|
e2etiming
command
e2etiming publishes what a lifecycle run spent its time on.
|
e2etiming publishes what a lifecycle run spent its time on. |
|
imagecopy
command
imagecopy copies a digest-pinned image, index and all, into another registry without changing a byte of it.
|
imagecopy copies a digest-pinned image, index and all, into another registry without changing a byte of it. |
|
ptahdriftcategories
command
Command ptahdriftcategories keeps support/ptah-drift-categories.json equal to the drift finding categories the pinned Ptah build can emit.
|
Command ptahdriftcategories keeps support/ptah-drift-categories.json equal to the drift finding categories the pinned Ptah build can emit. |
|
releaseverify
command
|
|
|
unknownlayerfixture
command
Command unknownlayerfixture publishes a migration artifact carrying one layer whose media type the pinned executor does not accept.
|
Command unknownlayerfixture publishes a migration artifact carrying one layer whose media type the pinned executor does not accept. |
|
updatekubernetessupport
command
Command updatekubernetessupport performs the live half of Kubernetes support maintenance.
|
Command updatekubernetessupport performs the live half of Kubernetes support maintenance. |
|
upgradealert
command
upgradealert observes one declared upgrade from outside the Helm release.
|
upgradealert observes one declared upgrade from outside the Helm release. |
|
verifycrdschemahistory
command
|
|
|
verifyptahsupport
command
Command verify-ptah-support validates the Ptah compatibility catalog and exports the one value the pipeline reads from it.
|
Command verify-ptah-support validates the Ptah compatibility catalog and exports the one value the pipeline reads from it. |
|
verifyrunnerprotocol
command
Command verifyrunnerprotocol holds runner.ProtocolVersion to the runner's source.
|
Command verifyrunnerprotocol holds runner.ProtocolVersion to the runner's source. |
|
internal
|
|
|
admission
Package admission implements the independently authorized approval boundary.
|
Package admission implements the independently authorized approval boundary. |
|
apipace
Package apipace bounds how fast one manager process sends requests to the Kubernetes API server.
|
Package apipace bounds how fast one manager process sends requests to the Kubernetes API server. |
|
controller
Package controller reconciles credential-isolated desired schema state.
|
Package controller reconciles credential-isolated desired schema state. |
|
controllerstate
Package controllerstate defines the manager-side durable-state contract.
|
Package controllerstate defines the manager-side durable-state contract. |
|
controllerwrite
Package controllerwrite validates the narrow set of workload and plan writes issued by the operator manager identity, and protects reserved result credentials against writes from any principal.
|
Package controllerwrite validates the narrow set of workload and plan writes issued by the operator manager identity, and protects reserved result credentials against writes from any principal. |
|
coordination
Package coordination names the database realm a desired-state resource claims.
|
Package coordination names the database realm a desired-state resource claims. |
|
dataplane
Package dataplane defines the narrow machine-readable contracts consumed by the controller.
|
Package dataplane defines the narrow machine-readable contracts consumed by the controller. |
|
fingerprint
Package fingerprint creates canonical content identities for reconciliation inputs.
|
Package fingerprint creates canonical content identities for reconciliation inputs. |
|
jobclaim
Package jobclaim decides whether a Job is the one a claim built.
|
Package jobclaim decides whether a Job is the one a claim built. |
|
lifecyclejournal
Package lifecyclejournal derives a resource's lifecycle journal from the status writes the controllers already make.
|
Package lifecyclejournal derives a resource's lifecycle journal from the status writes the controllers already make. |
|
managercache
Package managercache says what the manager keeps in memory from the resources it watches.
|
Package managercache says what the manager keeps in memory from the resources it watches. |
|
migrationplan
Package migrationplan publishes and re-derives the immutable manifest of one planned migration sequence.
|
Package migrationplan publishes and re-derives the immutable manifest of one planned migration sequence. |
|
migrationview
Package migrationview reads what the operator stored about one migration.
|
Package migrationview reads what the operator stored about one migration. |
|
mutationlifecycle
Package mutationlifecycle holds the obligations both resource families carry when an operation may have changed a database.
|
Package mutationlifecycle holds the obligations both resource families carry when an operation may have changed a database. |
|
ocireference
Package ocireference parses and binds the OCI references crossing the controller/data-plane trust boundary.
|
Package ocireference parses and binds the OCI references crossing the controller/data-plane trust boundary. |
|
plancontract
Package plancontract defines the byte-size contract shared by plan execution, transport, storage, and reconstruction.
|
Package plancontract defines the byte-size contract shared by plan execution, transport, storage, and reconstruction. |
|
planseal
Package planseal seals the Plan payload to a per-process manager key.
|
Package planseal seals the Plan payload to a per-process manager key. |
|
planstore
Package planstore publishes immutable executable plans without placing SQL in a custom-resource status or controller log.
|
Package planstore publishes immutable executable plans without placing SQL in a custom-resource status or controller log. |
|
planview
Package planview prints a plan for `kubectl ptah plan`.
|
Package planview prints a plan for `kubectl ptah plan`. |
|
podintent
Package podintent resolves and validates the bounded set of safe PodSpec mutations performed by Kubernetes admission and scheduling.
|
Package podintent resolves and validates the bounded set of safe PodSpec mutations performed by Kubernetes admission and scheduling. |
|
policy
Package policy binds verification policy bytes to plans and approvals.
|
Package policy binds verification policy bytes to plans and approvals. |
|
resultauthority
Package resultauthority checks live Kubernetes authority for result delivery.
|
Package resultauthority checks live Kubernetes authority for result delivery. |
|
resultcleanup
Package resultcleanup retires and collects runner evidence through direct API reads.
|
Package resultcleanup retires and collects runner evidence through direct API reads. |
|
resultconsumer
Package resultconsumer loads durable evidence outside reconciliation workers.
|
Package resultconsumer loads durable evidence outside reconciliation workers. |
|
resultcredentials
Package resultcredentials binds delivery to an operation's first Pod.
|
Package resultcredentials binds delivery to an operation's first Pod. |
|
resultcredentials/binding
Package binding describes public credential metadata and Pod references.
|
Package binding describes public credential metadata and Pod references. |
|
resultdelivery
Package resultdelivery implements authenticated, bounded delivery of an already executed operation.
|
Package resultdelivery implements authenticated, bounded delivery of an already executed operation. |
|
resultdelivery/jobconfig
Package jobconfig fixes the runner's durable-delivery inputs in its immutable Job template.
|
Package jobconfig fixes the runner's durable-delivery inputs in its immutable Job template. |
|
resultdelivery/resulttest
Package resulttest shares production Job fixtures for delivery component tests.
|
Package resulttest shares production Job fixtures for delivery component tests. |
|
resultretention
Package resultretention protects operation evidence independently of Jobs, certificate validity, and the currently elected manager.
|
Package resultretention protects operation evidence independently of Jobs, certificate validity, and the currently elected manager. |
|
resultservice
Package resultservice connects durable delivery to the manager lifecycle.
|
Package resultservice connects durable delivery to the manager lifecycle. |
|
resultstore
Package resultstore persists an already authenticated and validated runner payload.
|
Package resultstore persists an already authenticated and validated runner payload. |
|
schemaselector
Package schemaselector validates the bounded lexical contract shared by the API and the execution boundary for schema scope selectors.
|
Package schemaselector validates the bounded lexical contract shared by the API and the execution boundary for schema scope selectors. |
|
schemaview
Package schemaview reads where one PtahSchema stands.
|
Package schemaview reads where one PtahSchema stands. |
|
sourcebinding
Package sourcebinding holds the comparisons every component makes about a resource's source: which plan contract a source gives, what a plan binds in place of an artifact digest, and whether an operation's access binding reads the content a plan names.
|
Package sourcebinding holds the comparisons every component makes about a resource's source: which plan contract a source gives, what a plan binds in place of an artifact digest, and whether an operation's access binding reads the content a plan names. |
|
sourcecontent
Package sourcecontent defines the content digest of a delivered source: the files a schema or a migration directory is read from, whatever carried them.
|
Package sourcecontent defines the content digest of a delivered source: the files a schema or a migration directory is read from, whatever carried them. |
|
sourcepolicy
Package sourcepolicy reads and applies a source policy: what a team refuses for every ConfigMap and Git source, held in an immutable ConfigMap a resource selects with sourcePolicyFrom.
|
Package sourcepolicy reads and applies a source policy: what a team refuses for every ConfigMap and Git source, held in an immutable ConfigMap a resource selects with sourcePolicyFrom. |
|
sourcesnapshot
Package sourcesnapshot is the immutable ConfigMap a ConfigMap source is copied into.
|
Package sourcesnapshot is the immutable ConfigMap a ConfigMap source is copied into. |
|
sourceview
Package sourceview reduces the source a PtahSchema or a PtahMigration last resolved to what `kubectl ptah` prints: which kind of source it is, where it was read from, and what it resolved to.
|
Package sourceview reduces the source a PtahSchema or a PtahMigration last resolved to what `kubectl ptah` prints: which kind of source it is, where it was read from, and what it resolved to. |
|
targetlock
Package targetlock serializes database operations in the same user-declared physical coordination realm.
|
Package targetlock serializes database operations in the same user-declared physical coordination realm. |
|
telemetry
Package telemetry defines bounded-cardinality Prometheus telemetry for the reconciliation state machines of both resource families.
|
Package telemetry defines bounded-cardinality Prometheus telemetry for the reconciliation state machines of both resource families. |
|
workload
Package workload builds the bounded Kubernetes Jobs used by the schema controller.
|
Package workload builds the bounded Kubernetes Jobs used by the schema controller. |
|
pkg
|
|
|
planread
Package planread reads a stored schema plan back the way the operator reads it, for programs outside this module.
|
Package planread reads a stored schema plan back the way the operator reads it, for programs outside this module. |
|
planread/planreadtest
Package planreadtest holds stored plans in an in-memory API server, for tests of programs that read plans.
|
Package planreadtest holds stored plans in an in-memory API server, for tests of programs that read plans. |
|
test
|
|
|
e2e
Package e2e holds the acceptance phases the Go harness runs against the cluster hack/e2e-kind.sh stands up.
|
Package e2e holds the acceptance phases the Go harness runs against the cluster hack/e2e-kind.sh stands up. |
|
e2e/alertsink
command
Command alertsink is the receiver the alerting phase points Alertmanager at.
|
Command alertsink is the receiver the alerting phase points Alertmanager at. |
|
e2e/delayproxy
command
Command delayproxy stands in front of a database and holds every new connection for a declared delay before reaching it.
|
Command delayproxy stands in front of a database and holds every new connection for a declared delay before reaching it. |
|
e2e/gitrepo
Package gitrepo builds the Git repository the acceptance phase reads schemas and migrations from: a linear history described by a Spec, written into an in-memory object store with fixed authors and times, so the same Spec always gives the same commit ids.
|
Package gitrepo builds the Git repository the acceptance phase reads schemas and migrations from: a linear history described by a Spec, written into an in-memory object store with fixed authors and times, so the same Spec always gives the same commit ids. |
|
e2e/gitserver
command
Command e2e-git-server serves one Git repository for the acceptance phase that reads schemas and migration directories from Git: over smart HTTP behind TLS with a token, and over SSH with one authorized key.
|
Command e2e-git-server serves one Git repository for the acceptance phase that reads schemas and migration directories from Git: over smart HTTP behind TLS with a token, and over SSH with one authorized key. |
|
e2e/handcraftoci
command
Command handcraftoci publishes one intentionally unvalidated schema layer.
|
Command handcraftoci publishes one intentionally unvalidated schema layer. |
|
e2e/harness
Package harness runs the acceptance phases test/e2e carries, inside the cluster hack/e2e-kind.sh stands up.
|
Package harness runs the acceptance phases test/e2e carries, inside the cluster hack/e2e-kind.sh stands up. |
|
e2e/logstall
command
Command logstall serves one deliberately unfinished kubelet log response.
|
Command logstall serves one deliberately unfinished kubelet log response. |
|
e2e/phases
Package phases declares the acceptance phases the Go harness carries.
|
Package phases declares the acceptance phases the Go harness carries. |
|
e2e/resultframe
Package resultframe extracts one exact, integrity-bound runner result from an acceptance Pod's log.
|
Package resultframe extracts one exact, integrity-bound runner result from an acceptance Pod's log. |
|
e2e/runnerprotocolfixture
command
Command runnerprotocolfixture prepares a Go build overlay for an explicitly incompatible runner.
|
Command runnerprotocolfixture prepares a Go build overlay for an explicitly incompatible runner. |
|
envtest/internal/harness
Package harness starts the envtest control plane the suites under test/envtest share: one kube-apiserver and one etcd per package, and nothing else.
|
Package harness starts the envtest control plane the suites under test/envtest share: one kube-apiserver and one etcd per package, and nothing else. |
|
envtest/internal/policyenv
Package policyenv installs the chart's admission policies into an envtest API server in the state a completed install leaves them, and decides requests against them: which policy refused a request, and with what.
|
Package policyenv installs the chart's admission policies into an envtest API server in the state a completed install leaves them, and decides requests against them: which policy refused a request, and with what. |
Click to show internal directories.
Click to hide internal directories.