infrahub-server 1.2.0rc0__py3-none-any.whl → 1.2.1__py3-none-any.whl

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

@@ -0,0 +1,193 @@
+from infrahub.core.constants import (
+    AllowOverrideType,
+    BranchSupportType,
+    InfrahubKind,
+    RelationshipDeleteBehavior,
+)
+from infrahub.core.constants import RelationshipCardinality as Cardinality
+
+from ...attribute_schema import AttributeSchema as Attr
+from ...dropdown import DropdownChoice
+from ...generic_schema import GenericSchema
+from ...node_schema import NodeSchema
+from ...relationship_schema import (
+    RelationshipSchema as Rel,
+)
+
+builtin_ipam = GenericSchema(
+    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,
+    uniqueness_constraints=[["name__value"]],
+    generate_profile=False,
+    attributes=[
+        Attr(name="name", kind="Text", unique=True, branch=BranchSupportType.AWARE, order_weight=1000),
+        Attr(name="description", kind="Text", optional=True, branch=BranchSupportType.AWARE, order_weight=2000),
+    ],
+    relationships=[
+        Rel(
+            name="ip_prefixes",
+            label="IP Prefixes",
+            peer=InfrahubKind.IPPREFIX,
+            identifier="ip_namespace__ip_prefix",
+            optional=True,
+            cardinality=Cardinality.MANY,
+            on_delete=RelationshipDeleteBehavior.CASCADE,
+            allow_override=AllowOverrideType.NONE,
+        ),
+        Rel(
+            name="ip_addresses",
+            label="IP Addresses",
+            peer=InfrahubKind.IPADDRESS,
+            identifier="ip_namespace__ip_address",
+            optional=True,
+            cardinality=Cardinality.MANY,
+            on_delete=RelationshipDeleteBehavior.CASCADE,
+            allow_override=AllowOverrideType.NONE,
+        ),
+    ],
+)
+
+builtin_ip_prefix = GenericSchema(
+    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,
+    hierarchical=True,
+    attributes=[
+        Attr(name="prefix", kind="IPNetwork", branch=BranchSupportType.AWARE, order_weight=1000),
+        Attr(name="description", kind="Text", optional=True, branch=BranchSupportType.AWARE, order_weight=2000),
+        Attr(
+            name="member_type",
+            kind="Dropdown",
+            choices=[
+                DropdownChoice(
+                    name="prefix",
+                    label="Prefix",
+                    description="Prefix serves as container for other prefixes",
+                ),
+                DropdownChoice(
+                    name="address",
+                    label="Address",
+                    description="Prefix serves as subnet for IP addresses",
+                ),
+            ],
+            branch=BranchSupportType.AWARE,
+            default_value="address",
+            order_weight=3000,
+        ),
+        Attr(
+            name="is_pool",
+            kind="Boolean",
+            branch=BranchSupportType.AWARE,
+            default_value=False,
+            order_weight=4000,
+            description="All IP addresses within this prefix are considered usable",
+        ),
+        Attr(name="is_top_level", kind="Boolean", read_only=True, optional=True, allow_override=AllowOverrideType.NONE),
+        Attr(name="utilization", kind="Number", read_only=True, optional=True, allow_override=AllowOverrideType.NONE),
+        Attr(name="netmask", kind="Text", read_only=True, optional=True, allow_override=AllowOverrideType.NONE),
+        Attr(name="hostmask", kind="Text", read_only=True, optional=True, allow_override=AllowOverrideType.NONE),
+        Attr(name="network_address", kind="Text", read_only=True, optional=True, allow_override=AllowOverrideType.NONE),
+        Attr(
+            name="broadcast_address", kind="Text", read_only=True, optional=True, allow_override=AllowOverrideType.NONE
+        ),
+    ],
+    relationships=[
+        Rel(
+            name="ip_namespace",
+            label="IP Namespace",
+            peer=InfrahubKind.IPNAMESPACE,
+            identifier="ip_namespace__ip_prefix",
+            optional=True,
+            cardinality=Cardinality.ONE,
+            allow_override=AllowOverrideType.NONE,
+        ),
+        Rel(
+            name="ip_addresses",
+            label="IP Addresses",
+            peer=InfrahubKind.IPADDRESS,
+            identifier="ip_prefix__ip_address",
+            optional=True,
+            cardinality=Cardinality.MANY,
+            allow_override=AllowOverrideType.NONE,
+            read_only=True,
+        ),
+        Rel(
+            name="resource_pool",
+            peer="CoreIPAddressPool",
+            identifier="ipaddresspool__resource",
+            cardinality=Cardinality.MANY,
+            branch=BranchSupportType.AGNOSTIC,
+            optional=True,
+            read_only=True,
+        ),
+    ],
+)
+
+builtin_ip_address = GenericSchema(
+    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,
+    attributes=[
+        Attr(name="address", kind="IPHost", branch=BranchSupportType.AWARE, order_weight=1000),
+        Attr(name="description", kind="Text", optional=True, branch=BranchSupportType.AWARE, order_weight=2000),
+    ],
+    relationships=[
+        Rel(
+            name="ip_namespace",
+            label="IP Namespace",
+            peer=InfrahubKind.IPNAMESPACE,
+            identifier="ip_namespace__ip_address",
+            optional=True,
+            cardinality=Cardinality.ONE,
+            allow_override=AllowOverrideType.NONE,
+        ),
+        Rel(
+            name="ip_prefix",
+            label="IP Prefix",
+            peer=InfrahubKind.IPPREFIX,
+            identifier="ip_prefix__ip_address",
+            optional=True,
+            cardinality=Cardinality.ONE,
+            allow_override=AllowOverrideType.NONE,
+            read_only=True,
+        ),
+    ],
+)
+
+core_ipam_namespace = NodeSchema(
+    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,
+    inherit_from=[InfrahubKind.IPNAMESPACE],
+    attributes=[Attr(name="default", kind="Boolean", optional=True, read_only=True, order_weight=9000)],
+)

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

@@ -0,0 +1,19 @@
+from ...generic_schema import GenericSchema
+
+lineage_owner = GenericSchema(
+    name="Owner",
+    namespace="Lineage",
+    description="Any Entities that is responsible for some data.",
+    label="Owner",
+    include_in_menu=False,
+    documentation="/topics/metadata",
+)
+
+lineage_source = GenericSchema(
+    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,48 @@
+from infrahub.core.constants import (
+    NAMESPACE_REGEX,
+)
+
+from ...attribute_schema import AttributeSchema as Attr
+from ...generic_schema import GenericSchema
+from ...node_schema import NodeSchema
+
+generic_menu_item = GenericSchema(
+    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=[
+        Attr(name="namespace", kind="Text", regex=NAMESPACE_REGEX, order_weight=1000),
+        Attr(name="name", kind="Text", order_weight=1000),
+        Attr(name="label", kind="Text", optional=True, order_weight=2000),
+        Attr(name="kind", kind="Text", optional=True, order_weight=2500),
+        Attr(name="path", kind="Text", optional=True, order_weight=2500),
+        Attr(name="description", kind="Text", optional=True, order_weight=3000),
+        Attr(name="icon", kind="Text", optional=True, order_weight=4000),
+        Attr(name="protected", kind="Boolean", default_value=False, read_only=True, order_weight=5000),
+        Attr(name="order_weight", kind="Number", default_value=2000, order_weight=6000),
+        Attr(name="required_permissions", kind="List", optional=True, order_weight=7000),
+        Attr(
+            name="section",
+            kind="Text",
+            enum=["object", "internal"],
+            default_value="object",
+            order_weight=8000,
+        ),
+    ],
+)
+
+menu_item = NodeSchema(
+    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,163 @@
+from infrahub.core.constants import (
+    AllowOverrideType,
+    BranchSupportType,
+    GlobalPermissions,
+    InfrahubKind,
+    PermissionAction,
+    PermissionDecision,
+)
+from infrahub.core.constants import RelationshipCardinality as Cardinality
+from infrahub.core.constants import RelationshipKind as RelKind
+
+from ...attribute_schema import AttributeSchema as Attr
+from ...dropdown import DropdownChoice
+from ...generic_schema import GenericSchema
+from ...node_schema import NodeSchema
+from ...relationship_schema import (
+    RelationshipSchema as Rel,
+)
+
+core_base_permission = GenericSchema(
+    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=[
+        Attr(name="description", kind="Text", optional=True),
+        Attr(name="identifier", kind="Text", read_only=True, optional=True, allow_override=AllowOverrideType.NONE),
+    ],
+    relationships=[
+        Rel(
+            name="roles",
+            peer=InfrahubKind.ACCOUNTROLE,
+            optional=True,
+            identifier="role__permissions",
+            cardinality=Cardinality.MANY,
+            kind=RelKind.ATTRIBUTE,
+        )
+    ],
+)
+
+core_object_permission = NodeSchema(
+    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=[
+        Attr(name="namespace", kind="Text", order_weight=2000),
+        Attr(name="name", kind="Text", order_weight=3000),
+        Attr(
+            name="action",
+            kind="Text",
+            enum=PermissionAction.available_types(),
+            default_value=PermissionAction.ANY.value,
+            order_weight=4000,
+        ),
+        Attr(
+            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 = NodeSchema(
+    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,
+    attributes=[
+        Attr(
+            name="action",
+            kind="Dropdown",
+            choices=[DropdownChoice(name=permission.value) for permission in GlobalPermissions],
+            order_weight=2000,
+        ),
+        Attr(
+            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 = NodeSchema(
+    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=[Attr(name="name", kind="Text", unique=True)],
+    relationships=[
+        Rel(
+            name="groups",
+            peer=InfrahubKind.ACCOUNTGROUP,
+            optional=True,
+            identifier="role__accountgroups",
+            cardinality=Cardinality.MANY,
+            kind=RelKind.ATTRIBUTE,
+        ),
+        Rel(
+            name="permissions",
+            peer=InfrahubKind.BASEPERMISSION,
+            optional=True,
+            identifier="role__permissions",
+            cardinality=Cardinality.MANY,
+            kind=RelKind.ATTRIBUTE,
+        ),
+    ],
+)
+
+core_account_group = NodeSchema(
+    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,
+    relationships=[
+        Rel(
+            name="roles",
+            peer=InfrahubKind.ACCOUNTROLE,
+            optional=True,
+            identifier="role__accountgroups",
+            cardinality=Cardinality.MANY,
+            kind=RelKind.ATTRIBUTE,
+        ),
+    ],
+)

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

@@ -0,0 +1,18 @@
+from ...attribute_schema import AttributeSchema as Attr
+from ...generic_schema import GenericSchema
+
+core_profile_schema_definition = GenericSchema(
+    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=[
+        Attr(name="profile_name", kind="Text", min_length=3, max_length=32, unique=True, optional=False),
+        Attr(name="profile_priority", kind="Number", default_value=1000, optional=True),
+    ],
+)

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

@@ -0,0 +1,97 @@
+from infrahub.core.constants import (
+    BranchSupportType,
+    InfrahubKind,
+    RelationshipDeleteBehavior,
+)
+from infrahub.core.constants import RelationshipCardinality as Cardinality
+from infrahub.core.constants import RelationshipKind as RelKind
+from infrahub.proposed_change.constants import ProposedChangeState
+
+from ...attribute_schema import AttributeSchema as Attr
+from ...node_schema import NodeSchema
+from ...relationship_schema import (
+    RelationshipSchema as Rel,
+)
+
+core_proposed_change = NodeSchema(
+    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,
+    inherit_from=[InfrahubKind.TASKTARGET],
+    documentation="/topics/proposed-change",
+    attributes=[
+        Attr(name="name", kind="Text", optional=False),
+        Attr(name="description", kind="TextArea", optional=True),
+        Attr(name="source_branch", kind="Text", optional=False),
+        Attr(name="destination_branch", kind="Text", optional=False),
+        Attr(
+            name="state",
+            kind="Text",
+            enum=ProposedChangeState.available_types(),
+            default_value=ProposedChangeState.OPEN.value,
+            optional=True,
+        ),
+    ],
+    relationships=[
+        Rel(
+            name="approved_by",
+            peer=InfrahubKind.GENERICACCOUNT,
+            optional=True,
+            cardinality=Cardinality.MANY,
+            kind=RelKind.ATTRIBUTE,
+            branch=BranchSupportType.AGNOSTIC,
+            identifier="coreaccount__proposedchange_approved_by",
+        ),
+        Rel(
+            name="reviewers",
+            peer=InfrahubKind.GENERICACCOUNT,
+            optional=True,
+            cardinality=Cardinality.MANY,
+            kind=RelKind.ATTRIBUTE,
+            branch=BranchSupportType.AGNOSTIC,
+            identifier="coreaccount__proposedchange_reviewed_by",
+        ),
+        Rel(
+            name="created_by",
+            peer=InfrahubKind.GENERICACCOUNT,
+            optional=True,
+            cardinality=Cardinality.ONE,
+            kind=RelKind.ATTRIBUTE,
+            branch=BranchSupportType.AGNOSTIC,
+            identifier="coreaccount__proposedchange_created_by",
+        ),
+        Rel(
+            name="comments",
+            peer=InfrahubKind.CHANGECOMMENT,
+            kind=RelKind.COMPONENT,
+            optional=True,
+            cardinality=Cardinality.MANY,
+            on_delete=RelationshipDeleteBehavior.CASCADE,
+        ),
+        Rel(
+            name="threads",
+            peer=InfrahubKind.THREAD,
+            identifier="proposedchange__thread",
+            kind=RelKind.COMPONENT,
+            optional=True,
+            cardinality=Cardinality.MANY,
+            on_delete=RelationshipDeleteBehavior.CASCADE,
+        ),
+        Rel(
+            name="validations",
+            peer=InfrahubKind.VALIDATOR,
+            kind=RelKind.COMPONENT,
+            identifier="proposed_change__validator",
+            optional=True,
+            cardinality=Cardinality.MANY,
+            on_delete=RelationshipDeleteBehavior.CASCADE,
+        ),
+    ],
+)