diff --git a/services/resourcemanager/README.md b/services/resourcemanager/README.md new file mode 100644 index 000000000..510291cce --- /dev/null +++ b/services/resourcemanager/README.md @@ -0,0 +1,43 @@ +# stackit.resourcemanager +API v2 to manage resource containers - organizations, folders, projects incl. labels + +### Resource Management +STACKIT resource management handles the terms _Organization_, _Folder_, _Project_, _Label_, and the hierarchical structure between them. Technically, organizations, +folders, and projects are _Resource Containers_ to which a _Label_ can be attached to. The STACKIT _Resource Manager_ provides CRUD endpoints to query and to modify the state. + +### Organizations +STACKIT organizations are the base element to create and to use cloud-resources. An organization is bound to one customer account. Organizations have a lifecycle. +- Organizations are always the root node in resource hierarchy and do not have a parent + +### Projects +STACKIT projects are needed to use cloud-resources. Projects serve as wrapper for underlying technical structures and processes. Projects have a lifecycle. Projects compared to folders may have different policies. +- Projects are optional, but mandatory for cloud-resource usage +- A project can be created having either an organization, or a folder as parent +- A project must not have a project as parent +- Project names under the same parent must not be unique +- Root organization cannot be changed + +### Label +STACKIT labels are key-value pairs including a resource container reference. Labels can be defined and attached freely to resource containers by which resources can be organized and queried. +- Policy-based, immutable labels may exists + +For more information, please visit [https://support.stackit.cloud/servicedesk](https://support.stackit.cloud/servicedesk) + +This package is part of the STACKIT Python SDK. For additional information, please visit the [GitHub repository](https://github.com/stackitcloud/stackit-sdk-python) of the SDK. + + +## Installation & Usage +### pip install + +```sh +pip install stackit-resourcemanager +``` + +Then import the package: +```python +import stackit.resourcemanager +``` + +## Getting Started + +[Examples](https://github.com/stackitcloud/stackit-sdk-python/tree/main/examples) for the usage of the package can be found in the [GitHub repository](https://github.com/stackitcloud/stackit-sdk-python) of the SDK. \ No newline at end of file diff --git a/services/resourcemanager/pyproject.toml b/services/resourcemanager/pyproject.toml index 67353c39b..67b990cde 100644 --- a/services/resourcemanager/pyproject.toml +++ b/services/resourcemanager/pyproject.toml @@ -5,7 +5,7 @@ authors = [ "STACKIT Core Platform ", ] description = "Resource Manager API" -#readme = "README.md" +readme = "README.md" #license = "NoLicense" classifiers = [ "Programming Language :: Python :: 3", @@ -102,4 +102,4 @@ per-file-ignores = """ # E501: long descriptions/string values might lead to lines that are too long # B028: stacklevel for deprecation warning is irrelevant ./src/stackit/*/api/default_api.py: F841,B028,E501 -""" \ No newline at end of file +"""