infrahub-server 1.1.6__py3-none-any.whl → 1.2.0b1__py3-none-any.whl

infrahub/core/schema/definitions/core/ipam.py

@@ -0,0 +1,252 @@
+from infrahub.core.constants import (
+    AllowOverrideType,
+    BranchSupportType,
+    InfrahubKind,
+    RelationshipDeleteBehavior,
+)
+
+builtin_ipam = {
+    "name": "IPNamespace",
+    "namespace": "Builtin",
+    "label": "IP Namespace",
+    "description": "A generic container for IP prefixes and IP addresses",
+    "include_in_menu": False,
+    "default_filter": "name__value",
+    "order_by": ["name__value"],
+    "display_labels": ["name__value"],
+    "icon": "mdi:format-list-group",
+    "branch": BranchSupportType.AWARE.value,
+    "uniqueness_constraints": [["name__value"]],
+    "generate_profile": False,
+    "attributes": [
+        {
+            "name": "name",
+            "kind": "Text",
+            "unique": True,
+            "branch": BranchSupportType.AWARE.value,
+            "order_weight": 1000,
+        },
+        {
+            "name": "description",
+            "kind": "Text",
+            "optional": True,
+            "branch": BranchSupportType.AWARE.value,
+            "order_weight": 2000,
+        },
+    ],
+    "relationships": [
+        {
+            "name": "ip_prefixes",
+            "label": "IP Prefixes",
+            "peer": InfrahubKind.IPPREFIX,
+            "identifier": "ip_namespace__ip_prefix",
+            "optional": True,
+            "cardinality": "many",
+            "on_delete": RelationshipDeleteBehavior.CASCADE,
+            "allow_override": AllowOverrideType.NONE,
+        },
+        {
+            "name": "ip_addresses",
+            "label": "IP Addresses",
+            "peer": InfrahubKind.IPADDRESS,
+            "identifier": "ip_namespace__ip_address",
+            "optional": True,
+            "cardinality": "many",
+            "on_delete": RelationshipDeleteBehavior.CASCADE,
+            "allow_override": AllowOverrideType.NONE,
+        },
+    ],
+}
+
+builtin_ip_prefix = {
+    "name": "IPPrefix",
+    "label": "IP Prefix",
+    "namespace": "Builtin",
+    "description": "IPv6 or IPv4 prefix also referred as network",
+    "include_in_menu": False,
+    "default_filter": "prefix__value",
+    "order_by": ["prefix__version", "prefix__binary_address", "prefix__prefixlen"],
+    "display_labels": ["prefix__value"],
+    "icon": "mdi:ip-network",
+    "branch": BranchSupportType.AWARE.value,
+    "hierarchical": True,
+    "attributes": [
+        {
+            "name": "prefix",
+            "kind": "IPNetwork",
+            "branch": BranchSupportType.AWARE.value,
+            "order_weight": 1000,
+        },
+        {
+            "name": "description",
+            "kind": "Text",
+            "optional": True,
+            "branch": BranchSupportType.AWARE.value,
+            "order_weight": 2000,
+        },
+        {
+            "name": "member_type",
+            "kind": "Dropdown",
+            "choices": [
+                {
+                    "name": "prefix",
+                    "label": "Prefix",
+                    "description": "Prefix serves as container for other prefixes",
+                },
+                {
+                    "name": "address",
+                    "label": "Address",
+                    "description": "Prefix serves as subnet for IP addresses",
+                },
+            ],
+            "branch": BranchSupportType.AWARE.value,
+            "default_value": "address",
+            "order_weight": 3000,
+        },
+        {
+            "name": "is_pool",
+            "kind": "Boolean",
+            "branch": BranchSupportType.AWARE.value,
+            "default_value": False,
+            "order_weight": 4000,
+            "description": "All IP addresses within this prefix are considered usable",
+        },
+        {
+            "name": "is_top_level",
+            "kind": "Boolean",
+            "read_only": True,
+            "optional": True,
+            "allow_override": AllowOverrideType.NONE,
+        },
+        {
+            "name": "utilization",
+            "kind": "Number",
+            "read_only": True,
+            "optional": True,
+            "allow_override": AllowOverrideType.NONE,
+        },
+        {
+            "name": "netmask",
+            "kind": "Text",
+            "read_only": True,
+            "optional": True,
+            "allow_override": AllowOverrideType.NONE,
+        },
+        {
+            "name": "hostmask",
+            "kind": "Text",
+            "read_only": True,
+            "optional": True,
+            "allow_override": AllowOverrideType.NONE,
+        },
+        {
+            "name": "network_address",
+            "kind": "Text",
+            "read_only": True,
+            "optional": True,
+            "allow_override": AllowOverrideType.NONE,
+        },
+        {
+            "name": "broadcast_address",
+            "kind": "Text",
+            "read_only": True,
+            "optional": True,
+            "allow_override": AllowOverrideType.NONE,
+        },
+    ],
+    "relationships": [
+        {
+            "name": "ip_namespace",
+            "label": "IP Namespace",
+            "peer": InfrahubKind.IPNAMESPACE,
+            "identifier": "ip_namespace__ip_prefix",
+            "optional": True,
+            "cardinality": "one",
+            "allow_override": AllowOverrideType.NONE,
+        },
+        {
+            "name": "ip_addresses",
+            "label": "IP Addresses",
+            "peer": InfrahubKind.IPADDRESS,
+            "identifier": "ip_prefix__ip_address",
+            "optional": True,
+            "cardinality": "many",
+            "allow_override": AllowOverrideType.NONE,
+            "read_only": True,
+        },
+        {
+            "name": "resource_pool",
+            "peer": "CoreIPAddressPool",
+            "identifier": "ipaddresspool__resource",
+            "cardinality": "many",
+            "branch": BranchSupportType.AGNOSTIC.value,
+            "optional": True,
+            "read_only": True,
+        },
+    ],
+}
+
+builtin_ip_address = {
+    "name": "IPAddress",
+    "label": "IP Address",
+    "namespace": "Builtin",
+    "description": "IPv6 or IPv4 address",
+    "include_in_menu": False,
+    "default_filter": "address__value",
+    "order_by": ["address__version", "address__binary_address"],
+    "display_labels": ["address__value"],
+    "icon": "mdi:ip-outline",
+    "branch": BranchSupportType.AWARE.value,
+    "attributes": [
+        {
+            "name": "address",
+            "kind": "IPHost",
+            "branch": BranchSupportType.AWARE.value,
+            "order_weight": 1000,
+        },
+        {
+            "name": "description",
+            "kind": "Text",
+            "optional": True,
+            "branch": BranchSupportType.AWARE.value,
+            "order_weight": 2000,
+        },
+    ],
+    "relationships": [
+        {
+            "name": "ip_namespace",
+            "label": "IP Namespace",
+            "peer": InfrahubKind.IPNAMESPACE,
+            "identifier": "ip_namespace__ip_address",
+            "optional": True,
+            "cardinality": "one",
+            "allow_override": AllowOverrideType.NONE,
+        },
+        {
+            "name": "ip_prefix",
+            "label": "IP Prefix",
+            "peer": InfrahubKind.IPPREFIX,
+            "identifier": "ip_prefix__ip_address",
+            "optional": True,
+            "cardinality": "one",
+            "allow_override": AllowOverrideType.NONE,
+            "read_only": True,
+        },
+    ],
+}
+
+core_ipam_namespace = {
+    "name": "Namespace",
+    "namespace": "Ipam",
+    "description": "A namespace that segments IPAM",
+    "label": "IPAM Namespace",
+    "default_filter": "name__value",
+    "human_friendly_id": ["name__value"],
+    "order_by": ["name__value"],
+    "display_labels": ["name__value"],
+    "include_in_menu": False,
+    "icon": "mdi:format-list-group",
+    "branch": BranchSupportType.AWARE.value,
+    "inherit_from": [InfrahubKind.IPNAMESPACE],
+    "attributes": [{"name": "default", "kind": "Boolean", "optional": True, "read_only": True, "order_weight": 9000}],
+}

infrahub/core/schema/definitions/core/lineage.py

@@ -0,0 +1,17 @@
+lineage_owner = {
+    "name": "Owner",
+    "namespace": "Lineage",
+    "description": "Any Entities that is responsible for some data.",
+    "label": "Owner",
+    "include_in_menu": False,
+    "documentation": "/topics/metadata",
+}
+
+lineage_source = {
+    "name": "Source",
+    "namespace": "Lineage",
+    "description": "Any Entities that stores or produces data.",
+    "label": "Source",
+    "include_in_menu": False,
+    "documentation": "/topics/metadata",
+}

infrahub/core/schema/definitions/core/menu.py

@@ -0,0 +1,46 @@
+from typing import Any
+
+from infrahub.core.constants import (
+    NAMESPACE_REGEX,
+)
+
+generic_menu_item: dict[str, Any] = {
+    "name": "Menu",
+    "namespace": "Core",
+    "include_in_menu": False,
+    "description": "Element of the Menu",
+    "label": "Menu",
+    "hierarchical": True,
+    "human_friendly_id": ["namespace__value", "name__value"],
+    "display_labels": ["label__value"],
+    "generate_profile": False,
+    "attributes": [
+        {"name": "namespace", "kind": "Text", "regex": NAMESPACE_REGEX, "order_weight": 1000},
+        {"name": "name", "kind": "Text", "order_weight": 1000},
+        {"name": "label", "kind": "Text", "optional": True, "order_weight": 2000},
+        {"name": "kind", "kind": "Text", "optional": True, "order_weight": 2500},
+        {"name": "path", "kind": "Text", "optional": True, "order_weight": 2500},
+        {"name": "description", "kind": "Text", "optional": True, "order_weight": 3000},
+        {"name": "icon", "kind": "Text", "optional": True, "order_weight": 4000},
+        {"name": "protected", "kind": "Boolean", "default_value": False, "read_only": True, "order_weight": 5000},
+        {"name": "order_weight", "kind": "Number", "default_value": 2000, "order_weight": 6000},
+        {"name": "required_permissions", "kind": "List", "optional": True, "order_weight": 7000},
+        {
+            "name": "section",
+            "kind": "Text",
+            "enum": ["object", "internal"],
+            "default_value": "object",
+            "order_weight": 8000,
+        },
+    ],
+}
+
+menu_item: dict[str, Any] = {
+    "name": "MenuItem",
+    "namespace": "Core",
+    "include_in_menu": False,
+    "description": "Menu Item",
+    "label": "Menu Item",
+    "inherit_from": ["CoreMenu"],
+    "generate_profile": False,
+}

infrahub/core/schema/definitions/core/permission.py

@@ -0,0 +1,161 @@
+from infrahub.core.constants import (
+    AllowOverrideType,
+    BranchSupportType,
+    GlobalPermissions,
+    InfrahubKind,
+    PermissionAction,
+    PermissionDecision,
+)
+
+core_base_permission = {
+    "name": "BasePermission",
+    "namespace": "Core",
+    "description": "A permission grants right to an account",
+    "label": "Base permission",
+    "icon": "mdi:user-key",
+    "include_in_menu": False,
+    "generate_profile": False,
+    "attributes": [
+        {"name": "description", "kind": "Text", "optional": True},
+        {
+            "name": "identifier",
+            "kind": "Text",
+            "read_only": True,
+            "optional": True,
+            "allow_override": AllowOverrideType.NONE,
+        },
+    ],
+    "relationships": [
+        {
+            "name": "roles",
+            "peer": InfrahubKind.ACCOUNTROLE,
+            "optional": True,
+            "identifier": "role__permissions",
+            "cardinality": "many",
+            "kind": "Attribute",
+        }
+    ],
+}
+
+core_object_permission = {
+    "name": "ObjectPermission",
+    "namespace": "Core",
+    "description": "A permission that grants rights to perform actions on objects",
+    "label": "Object permission",
+    "include_in_menu": False,
+    "order_by": ["namespace__value", "name__value", "action__value", "decision__value"],
+    "display_labels": ["namespace__value", "name__value", "action__value", "decision__value"],
+    "human_friendly_id": ["namespace__value", "name__value", "action__value", "decision__value"],
+    "uniqueness_constraints": [["namespace__value", "name__value", "action__value", "decision__value"]],
+    "generate_profile": False,
+    "inherit_from": [InfrahubKind.BASEPERMISSION],
+    "attributes": [
+        {"name": "namespace", "kind": "Text", "order_weight": 2000},
+        {"name": "name", "kind": "Text", "order_weight": 3000},
+        {
+            "name": "action",
+            "kind": "Text",
+            "enum": PermissionAction.available_types(),
+            "default_value": PermissionAction.ANY.value,
+            "order_weight": 4000,
+        },
+        {
+            "name": "decision",
+            "kind": "Number",
+            "enum": PermissionDecision.available_types(),
+            "default_value": PermissionDecision.ALLOW_ALL.value,
+            "order_weight": 5000,
+            "description": (
+                "Decide to deny or allow the action. If allowed, it can be configured for the default branch, any other branches or all "
+                "branches"
+            ),
+        },
+    ],
+}
+
+core_global_permission = {
+    "name": "GlobalPermission",
+    "namespace": "Core",
+    "description": "A permission that grants global rights to perform actions in Infrahub",
+    "label": "Global permission",
+    "include_in_menu": False,
+    "order_by": ["action__value", "decision__value"],
+    "display_labels": ["action__value", "decision__value"],
+    "human_friendly_id": ["action__value", "decision__value"],
+    "generate_profile": False,
+    "inherit_from": [InfrahubKind.BASEPERMISSION],
+    "branch": BranchSupportType.AGNOSTIC.value,
+    "attributes": [
+        {
+            "name": "action",
+            "kind": "Dropdown",
+            "choices": [{"name": permission.value} for permission in GlobalPermissions],
+            "order_weight": 2000,
+        },
+        {
+            "name": "decision",
+            "kind": "Number",
+            "enum": PermissionDecision.available_types(),
+            "default_value": PermissionDecision.ALLOW_ALL.value,
+            "order_weight": 3000,
+            "description": "Decide to deny or allow the action at a global level",
+        },
+    ],
+}
+
+core_account_role = {
+    "name": "AccountRole",
+    "namespace": "Core",
+    "description": "A role defines a set of permissions to grant to a group of accounts",
+    "label": "Account role",
+    "icon": "mdi:user-badge",
+    "include_in_menu": False,
+    "order_by": ["name__value"],
+    "display_labels": ["name__value"],
+    "human_friendly_id": ["name__value"],
+    "generate_profile": False,
+    "attributes": [{"name": "name", "kind": "Text", "unique": True}],
+    "relationships": [
+        {
+            "name": "groups",
+            "peer": InfrahubKind.ACCOUNTGROUP,
+            "optional": True,
+            "identifier": "role__accountgroups",
+            "cardinality": "many",
+            "kind": "Attribute",
+        },
+        {
+            "name": "permissions",
+            "peer": InfrahubKind.BASEPERMISSION,
+            "optional": True,
+            "identifier": "role__permissions",
+            "cardinality": "many",
+            "kind": "Attribute",
+        },
+    ],
+}
+
+core_account_group = {
+    "name": "AccountGroup",
+    "namespace": "Core",
+    "description": "A group of users to manage common permissions",
+    "label": "Account group",
+    "icon": "mdi:account-group",
+    "include_in_menu": False,
+    "order_by": ["name__value"],
+    "display_labels": ["name__value"],
+    "human_friendly_id": ["name__value"],
+    "generate_profile": False,
+    "inherit_from": [InfrahubKind.LINEAGEOWNER, InfrahubKind.LINEAGESOURCE, InfrahubKind.GENERICGROUP],
+    "branch": BranchSupportType.AGNOSTIC.value,
+    "relationships": [
+        {
+            "name": "roles",
+            "peer": InfrahubKind.ACCOUNTROLE,
+            "optional": True,
+            "identifier": "role__accountgroups",
+            "cardinality": "many",
+            "kind": "Attribute",
+        }
+    ],
+}

infrahub/core/schema/definitions/core/profile.py

@@ -0,0 +1,29 @@
+from typing import Any
+
+core_profile_schema_definition: dict[str, Any] = {
+    "name": "Profile",
+    "namespace": "Core",
+    "include_in_menu": False,
+    "icon": "mdi:shape-plus-outline",
+    "description": "Base Profile in Infrahub.",
+    "label": "Profile",
+    "display_labels": ["profile_name__value"],
+    "default_filter": "profile_name__value",
+    "uniqueness_constraints": [["profile_name__value"]],
+    "attributes": [
+        {
+            "name": "profile_name",
+            "kind": "Text",
+            "min_length": 3,
+            "max_length": 32,
+            "optional": False,
+            "unique": True,
+        },
+        {
+            "name": "profile_priority",
+            "kind": "Number",
+            "default_value": 1000,
+            "optional": True,
+        },
+    ],
+}

infrahub/core/schema/definitions/core/propose_change.py

@@ -0,0 +1,88 @@
+from infrahub.core.constants import (
+    BranchSupportType,
+    InfrahubKind,
+    RelationshipDeleteBehavior,
+)
+from infrahub.proposed_change.constants import ProposedChangeState
+
+core_proposed_change = {
+    "name": "ProposedChange",
+    "namespace": "Core",
+    "description": "Metadata related to a proposed change",
+    "include_in_menu": False,
+    "icon": "mdi:file-replace-outline",
+    "label": "Proposed Change",
+    "default_filter": "name__value",
+    "display_labels": ["name__value"],
+    "generate_profile": False,
+    "branch": BranchSupportType.AGNOSTIC.value,
+    "inherit_from": [InfrahubKind.TASKTARGET],
+    "documentation": "/topics/proposed-change",
+    "attributes": [
+        {"name": "name", "kind": "Text", "optional": False},
+        {"name": "description", "kind": "TextArea", "optional": True},
+        {"name": "source_branch", "kind": "Text", "optional": False},
+        {"name": "destination_branch", "kind": "Text", "optional": False},
+        {
+            "name": "state",
+            "kind": "Text",
+            "enum": ProposedChangeState.available_types(),
+            "default_value": ProposedChangeState.OPEN.value,
+            "optional": True,
+        },
+    ],
+    "relationships": [
+        {
+            "name": "approved_by",
+            "peer": InfrahubKind.GENERICACCOUNT,
+            "optional": True,
+            "cardinality": "many",
+            "kind": "Attribute",
+            "branch": BranchSupportType.AGNOSTIC.value,
+            "identifier": "coreaccount__proposedchange_approved_by",
+        },
+        {
+            "name": "reviewers",
+            "peer": InfrahubKind.GENERICACCOUNT,
+            "optional": True,
+            "kind": "Attribute",
+            "cardinality": "many",
+            "branch": BranchSupportType.AGNOSTIC.value,
+            "identifier": "coreaccount__proposedchange_reviewed_by",
+        },
+        {
+            "name": "created_by",
+            "peer": InfrahubKind.GENERICACCOUNT,
+            "optional": True,
+            "cardinality": "one",
+            "branch": BranchSupportType.AGNOSTIC.value,
+            "identifier": "coreaccount__proposedchange_created_by",
+        },
+        {
+            "name": "comments",
+            "peer": InfrahubKind.CHANGECOMMENT,
+            "kind": "Component",
+            "optional": True,
+            "cardinality": "many",
+            "on_delete": RelationshipDeleteBehavior.CASCADE,
+        },
+        {
+            "name": "threads",
+            "peer": InfrahubKind.THREAD,
+            "identifier": "proposedchange__thread",
+            "kind": "Component",
+            "optional": True,
+            "cardinality": "many",
+            "on_delete": RelationshipDeleteBehavior.CASCADE,
+        },
+        {
+            "name": "validations",
+            "peer": InfrahubKind.VALIDATOR,
+            "kind": "Component",
+            "identifier": "proposed_change__validator",
+            "optional": True,
+            "cardinality": "many",
+            "on_delete": RelationshipDeleteBehavior.CASCADE,
+        },
+    ],
+}