introduce environment metadata field for domains (#2487)

Signed-off-by: Henry Avetisyan <[email protected]> Co-authored-by: Henry Avetisyan <[email protected]>
AthenZ · Jan 22, 2024 · 73194d0 · 73194d0
1 parent e7fc7fe
commit 73194d0
Show file tree

Hide file tree

Showing 28 changed files with 393 additions and 40 deletions.
diff --git a/clients/go/zms/model.go b/clients/go/zms/model.go
diff --git a/clients/go/zms/zms_schema.go b/clients/go/zms/zms_schema.go
diff --git a/core/zms/src/main/java/com/yahoo/athenz/zms/Domain.java b/core/zms/src/main/java/com/yahoo/athenz/zms/Domain.java
@@ -93,6 +93,9 @@ public class Domain {
     @RdlOptional
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     public Map<String, String> contacts;
+    @RdlOptional
+    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    public String environment;
     public String name;
     @RdlOptional
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
@@ -276,6 +279,13 @@ public Domain setContacts(Map<String, String> contacts) {
     public Map<String, String> getContacts() {
         return contacts;
     }
+    public Domain setEnvironment(String environment) {
+        this.environment = environment;
+        return this;
+    }
+    public String getEnvironment() {
+        return environment;
+    }
     public Domain setName(String name) {
         this.name = name;
         return this;
@@ -380,6 +390,9 @@ public boolean equals(Object another) {
             if (contacts == null ? a.contacts != null : !contacts.equals(a.contacts)) {
                 return false;
             }
+            if (environment == null ? a.environment != null : !environment.equals(a.environment)) {
+                return false;
+            }
             if (name == null ? a.name != null : !name.equals(a.name)) {
                 return false;
             }

diff --git a/core/zms/src/main/java/com/yahoo/athenz/zms/DomainData.java b/core/zms/src/main/java/com/yahoo/athenz/zms/DomainData.java
@@ -89,6 +89,9 @@ public class DomainData {
     @RdlOptional
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     public Map<String, String> contacts;
+    @RdlOptional
+    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    public String environment;
     public String name;
     public List<Role> roles;
     public SignedPolicies policies;
@@ -272,6 +275,13 @@ public DomainData setContacts(Map<String, String> contacts) {
     public Map<String, String> getContacts() {
         return contacts;
     }
+    public DomainData setEnvironment(String environment) {
+        this.environment = environment;
+        return this;
+    }
+    public String getEnvironment() {
+        return environment;
+    }
     public DomainData setName(String name) {
         this.name = name;
         return this;
@@ -404,6 +414,9 @@ public boolean equals(Object another) {
             if (contacts == null ? a.contacts != null : !contacts.equals(a.contacts)) {
                 return false;
             }
+            if (environment == null ? a.environment != null : !environment.equals(a.environment)) {
+                return false;
+            }
             if (name == null ? a.name != null : !name.equals(a.name)) {
                 return false;
             }

diff --git a/core/zms/src/main/java/com/yahoo/athenz/zms/DomainMeta.java b/core/zms/src/main/java/com/yahoo/athenz/zms/DomainMeta.java
@@ -89,6 +89,9 @@ public class DomainMeta {
     @RdlOptional
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     public Map<String, String> contacts;
+    @RdlOptional
+    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    public String environment;
 
     public DomainMeta setDescription(String description) {
         this.description = description;
@@ -265,6 +268,13 @@ public DomainMeta setContacts(Map<String, String> contacts) {
     public Map<String, String> getContacts() {
         return contacts;
     }
+    public DomainMeta setEnvironment(String environment) {
+        this.environment = environment;
+        return this;
+    }
+    public String getEnvironment() {
+        return environment;
+    }
 
     @Override
     public boolean equals(Object another) {
@@ -348,6 +358,9 @@ public boolean equals(Object another) {
             if (contacts == null ? a.contacts != null : !contacts.equals(a.contacts)) {
                 return false;
             }
+            if (environment == null ? a.environment != null : !environment.equals(a.environment)) {
+                return false;
+            }
         }
         return true;
     }

diff --git a/core/zms/src/main/java/com/yahoo/athenz/zms/SubDomain.java b/core/zms/src/main/java/com/yahoo/athenz/zms/SubDomain.java
@@ -89,6 +89,9 @@ public class SubDomain {
     @RdlOptional
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     public Map<String, String> contacts;
+    @RdlOptional
+    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    public String environment;
     public String name;
     public List<String> adminUsers;
     @RdlOptional
@@ -271,6 +274,13 @@ public SubDomain setContacts(Map<String, String> contacts) {
     public Map<String, String> getContacts() {
         return contacts;
     }
+    public SubDomain setEnvironment(String environment) {
+        this.environment = environment;
+        return this;
+    }
+    public String getEnvironment() {
+        return environment;
+    }
     public SubDomain setName(String name) {
         this.name = name;
         return this;
@@ -382,6 +392,9 @@ public boolean equals(Object another) {
             if (contacts == null ? a.contacts != null : !contacts.equals(a.contacts)) {
                 return false;
             }
+            if (environment == null ? a.environment != null : !environment.equals(a.environment)) {
+                return false;
+            }
             if (name == null ? a.name != null : !name.equals(a.name)) {
                 return false;
             }

diff --git a/core/zms/src/main/java/com/yahoo/athenz/zms/TopLevelDomain.java b/core/zms/src/main/java/com/yahoo/athenz/zms/TopLevelDomain.java
@@ -90,6 +90,9 @@ public class TopLevelDomain {
     @RdlOptional
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     public Map<String, String> contacts;
+    @RdlOptional
+    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    public String environment;
     public String name;
     public List<String> adminUsers;
     @RdlOptional
@@ -271,6 +274,13 @@ public TopLevelDomain setContacts(Map<String, String> contacts) {
     public Map<String, String> getContacts() {
         return contacts;
     }
+    public TopLevelDomain setEnvironment(String environment) {
+        this.environment = environment;
+        return this;
+    }
+    public String getEnvironment() {
+        return environment;
+    }
     public TopLevelDomain setName(String name) {
         this.name = name;
         return this;
@@ -375,6 +385,9 @@ public boolean equals(Object another) {
             if (contacts == null ? a.contacts != null : !contacts.equals(a.contacts)) {
                 return false;
             }
+            if (environment == null ? a.environment != null : !environment.equals(a.environment)) {
+                return false;
+            }
             if (name == null ? a.name != null : !name.equals(a.name)) {
                 return false;
             }

diff --git a/core/zms/src/main/java/com/yahoo/athenz/zms/UserDomain.java b/core/zms/src/main/java/com/yahoo/athenz/zms/UserDomain.java
@@ -89,6 +89,9 @@ public class UserDomain {
     @RdlOptional
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
     public Map<String, String> contacts;
+    @RdlOptional
+    @JsonInclude(JsonInclude.Include.NON_EMPTY)
+    public String environment;
     public String name;
     @RdlOptional
     @JsonInclude(JsonInclude.Include.NON_EMPTY)
@@ -269,6 +272,13 @@ public UserDomain setContacts(Map<String, String> contacts) {
     public Map<String, String> getContacts() {
         return contacts;
     }
+    public UserDomain setEnvironment(String environment) {
+        this.environment = environment;
+        return this;
+    }
+    public String getEnvironment() {
+        return environment;
+    }
     public UserDomain setName(String name) {
         this.name = name;
         return this;
@@ -366,6 +376,9 @@ public boolean equals(Object another) {
             if (contacts == null ? a.contacts != null : !contacts.equals(a.contacts)) {
                 return false;
             }
+            if (environment == null ? a.environment != null : !environment.equals(a.environment)) {
+                return false;
+            }
             if (name == null ? a.name != null : !name.equals(a.name)) {
                 return false;
             }

diff --git a/core/zms/src/main/java/com/yahoo/athenz/zms/ZMSSchema.java b/core/zms/src/main/java/com/yahoo/athenz/zms/ZMSSchema.java
@@ -141,7 +141,8 @@ private static Schema build() {
             .field("memberPurgeExpiryDays", "Int32", true, "purge role/group members with expiry date configured days in the past")
             .field("productId", "String", true, "associated product id (system attribute - uniqueness check - if enabled)")
             .field("featureFlags", "Int32", true, "features enabled per domain (system attribute)")
-            .mapField("contacts", "SimpleName", "String", true, "list of domain contacts (PE-Owner, Product-Owner, etc), each type can have a single value");
+            .mapField("contacts", "SimpleName", "String", true, "list of domain contacts (PE-Owner, Product-Owner, etc), each type can have a single value")
+            .field("environment", "String", true, "domain environment e.g. production, staging, etc");
 
         sb.structType("Domain", "DomainMeta")
             .comment("A domain is an independent partition of users, roles, and resources. Its name represents the definition of a namespace; the only way a new namespace can be created, from the top, is by creating Domains. Administration of a domain is governed by the parent domain (using reverse-DNS namespaces). The top level domains are governed by the special \"sys.auth\" domain.")

diff --git a/core/zms/src/main/rdl/Domain.tdl b/core/zms/src/main/rdl/Domain.tdl
@@ -31,6 +31,7 @@ type DomainMeta Struct {
     String productId (optional); //associated product id (system attribute - uniqueness check - if enabled)
     Int32 featureFlags (optional); //features enabled per domain (system attribute)
     Map<SimpleName,String> contacts (optional); //list of domain contacts (PE-Owner, Product-Owner, etc), each type can have a single value
+    String environment (optional); //domain environment e.g. production, staging, etc
 }
 
 //A domain is an independent partition of users, roles, and resources.