Skip to content

Commit e0c5d62

Browse files
Generate resourcemanager
1 parent f00ad2d commit e0c5d62

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

services/resourcemanager/README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# stackit.resourcemanager
2+
API v2 to manage resource containers - organizations, folders, projects incl. labels
3+
4+
### Resource Management
5+
STACKIT resource management handles the terms _Organization_, _Folder_, _Project_, _Label_, and the hierarchical structure between them. Technically, organizations,
6+
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.
7+
8+
### Organizations
9+
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.
10+
- Organizations are always the root node in resource hierarchy and do not have a parent
11+
12+
### Projects
13+
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.
14+
- Projects are optional, but mandatory for cloud-resource usage
15+
- A project can be created having either an organization, or a folder as parent
16+
- A project must not have a project as parent
17+
- Project names under the same parent must not be unique
18+
- Root organization cannot be changed
19+
20+
### Label
21+
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.
22+
- Policy-based, immutable labels may exists
23+
24+
For more information, please visit [https://support.stackit.cloud/servicedesk](https://support.stackit.cloud/servicedesk)
25+
26+
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.
27+
28+
29+
## Installation & Usage
30+
### pip install
31+
32+
```sh
33+
pip install stackit-resourcemanager
34+
```
35+
36+
Then import the package:
37+
```python
38+
import stackit.resourcemanager
39+
```
40+
41+
## Getting Started
42+
43+
[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.

0 commit comments

Comments
 (0)