bin/orchstratord: Add instructions for usage

Author: def-

misc/kind/cluster.yaml

@@ -157,18 +157,21 @@ nodes:
     image: kindest/node:v1.31.6
     labels:
       materialize.cloud/disk: true
+      materialize.cloud/swap: true
       materialize.cloud/availability-zone: "1"
       topology.kubernetes.io/zone: "1"
   - role: worker
     image: kindest/node:v1.31.6
     labels:
       materialize.cloud/disk: true
+      materialize.cloud/swap: true
       materialize.cloud/availability-zone: "2"
       topology.kubernetes.io/zone: "2"
   - role: worker
     image: kindest/node:v1.31.6
     labels:
       materialize.cloud/disk: true
+      materialize.cloud/swap: true
       materialize.cloud/availability-zone: "3"
       topology.kubernetes.io/zone: "3"
 
@@ -177,6 +180,7 @@ nodes:
     image: kindest/node:v1.31.6
     labels:
       materialize.cloud/disk: false
+      materialize.cloud/swap: false
       materialize.cloud/availability-zone: "1"
       topology.kubernetes.io/zone: "1"
 
@@ -185,11 +189,13 @@ nodes:
     image: kindest/node:v1.31.6
     labels:
       materialize.cloud/disk: true
+      materialize.cloud/swap: true
       materialize.cloud/availability-zone: "3"
       topology.kubernetes.io/zone: "3"
   - role: worker
     image: kindest/node:v1.31.6
     labels:
       materialize.cloud/disk: true
+      materialize.cloud/swap: true
       materialize.cloud/availability-zone: "3"
       topology.kubernetes.io/zone: "3"

misc/python/materialize/cli/orchestratord.py

@@ -27,18 +27,27 @@
 from materialize.docker import image_registry
 
 DEV_IMAGE_TAG = "local-dev"
-DEFAULT_POSTGRES = (
-    "postgres://[email protected]:5432/materialize"
-)
-DEFAULT_MINIO = "s3://minio:minio123@persist/persist?endpoint=http%3A%2F%2Fminio.materialize.svc.cluster.local%3A9000&region=minio"
+DEFAULT_POSTGRES = "postgres://materialize_user:[email protected]:5432/materialize_db?sslmode=disable"
+DEFAULT_MINIO = "s3://minio:minio123@bucket/12345678-1234-1234-1234-123456789012?endpoint=http%3A%2F%2Fminio.materialize.svc.cluster.local%3A9000&region=minio"
 
 
 def main():
     os.chdir(MZ_ROOT)
+    # Console is not on GHCR yet
+    os.environ["MZ_GHCR"] = "0"
 
     parser = argparse.ArgumentParser(
         prog="orchestratord",
-        description="""Runs orchestratord within a local kind cluster""",
+        description="Runs orchestratord within a local kind cluster",
+        usage="""
+For a new setup you can run:
+  kind delete cluster
+  kind create cluster --config misc/kind/cluster.yaml
+  kubectl create namespace materialize
+  kubectl apply -f misc/helm-charts/testing/postgres.yaml
+  kubectl apply -f misc/helm-charts/testing/minio.yaml
+  bin/orchestratord run
+  bin/orchestratord environment --license-key-file ~/license-key""",
     )
     parser.add_argument(
         "--kind-cluster-name",

src/cloud-resources/src/crd/materialize.rs

@@ -30,6 +30,8 @@ use crate::crd::generated::cert_manager::certificates::{
     CertificateIssuerRef, CertificateSecretTemplate,
 };
 
+const V26_0_0: Version = Version::new(26, 0, 0);
+
 pub const LAST_KNOWN_ACTIVE_GENERATION_ANNOTATION: &str =
     "materialize.cloud/last-known-active-generation";
 
@@ -500,13 +502,15 @@ pub mod v1alpha1 {
                 parse_image_ref(&self.spec.environmentd_image_ref),
                 current_environmentd_version,
             ) {
-                // We deny upgrades past 1 major version of the last successful rollout.
-                new_environmentd_version.major <= current_environmentd_version.major + 1
-            } else {
-                // If we couldn't parse either versions, we allow the upgrade since environmentd
-                // will still be able to determine if the upgrade is allowed or not.
-                true
+                if current_environmentd_version >= V26_0_0 {
+                    // We deny upgrades past 1 major version of the last successful rollout
+                    return new_environmentd_version.major
+                        <= current_environmentd_version.major + 1;
+                }
             }
+            // If we fail any of the preconditions for the check (e.g. we couldn't parse either version),
+            // we still allow the upgrade since environmentd will still error if the upgrade is not allowed.
+            true
         }
 
         pub fn managed_resource_meta(&self, name: String) -> ObjectMeta {
@@ -669,4 +673,51 @@ mod tests {
         mz.spec.environmentd_image_ref = "my.private.registry:5000:v0.33.3".to_owned();
         assert!(!mz.meets_minimum_version(&Version::parse("0.34.0").unwrap()));
     }
+
+    #[mz_ore::test]
+    fn within_upgrade_window() {
+        use super::v1alpha1::MaterializeStatus;
+
+        let mut mz = Materialize {
+            spec: MaterializeSpec {
+                environmentd_image_ref: "materialize/environmentd:v26.0.0".to_owned(),
+                ..Default::default()
+            },
+            metadata: ObjectMeta {
+                ..Default::default()
+            },
+            status: Some(MaterializeStatus {
+                last_completed_rollout_environmentd_image_ref: Some(
+                    "materialize/environmentd:v26.0.0".to_owned(),
+                ),
+                ..Default::default()
+            }),
+        };
+
+        // Pass: upgrading from 26.0.0 to 27.7.3 (within 1 major version)
+        mz.spec.environmentd_image_ref = "materialize/environmentd:v27.7.3".to_owned();
+        assert!(mz.within_upgrade_window());
+
+        // Pass: upgrading from 26.0.0 to 27.7.8-dev.0 (within 1 major version, pre-release)
+        mz.spec.environmentd_image_ref = "materialize/environmentd:v27.7.8-dev.0".to_owned();
+        assert!(mz.within_upgrade_window());
+
+        // Fail: upgrading from 26.0.0 to 28.0.1 (more than 1 major version)
+        mz.spec.environmentd_image_ref = "materialize/environmentd:v28.0.1".to_owned();
+        assert!(!mz.within_upgrade_window());
+
+        // Pass: upgrading from 26.0.0 to 28.0.1.not_a_valid_version (invalid version, defaults to true)
+        mz.spec.environmentd_image_ref =
+            "materialize/environmentd:v28.0.1.not_a_valid_version".to_owned();
+        assert!(mz.within_upgrade_window());
+
+        // Pass: upgrading from 0.147.5 to 26.1.0 (any version before 26.0.0 passes)
+        mz.status
+            .as_mut()
+            .unwrap()
+            .last_completed_rollout_environmentd_image_ref =
+            Some("materialize/environmentd:v0.147.5".to_owned());
+        mz.spec.environmentd_image_ref = "materialize/environmentd:v26.1.0".to_owned();
+        assert!(mz.within_upgrade_window());
+    }
 }