Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 36 additions & 34 deletions services/resourcemanager/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# stackit-sdk-resourcemanager

Resource Manager API
# STACKIT Java SDK for Resource Manager API

- API version: 2.0

Expand Down Expand Up @@ -30,37 +28,56 @@ For more information, please visit [https://support.stackit.cloud/servicedesk](h

This package is part of the STACKIT Java SDK. For additional information, please visit the [GitHub repository](https://github.com/stackitcloud/stackit-sdk-java) of the SDK.

## Installation from Maven Central (recommended)

## Requirements
The release artifacts for this SDK submodule are available on [Maven Central](https://central.sonatype.com/artifact/cloud.stackit.sdk/resourcemanager).

Building the API client library requires:
1. Java SDK (version 11 to 21 should be supported) installed on your system
### Maven users

## Installation
Add this dependency to your project's POM:

To install the API client library to your local Maven repository, simply execute:
```xml
<dependency>
<groupId>cloud.stackit.sdk</groupId>
<artifactId>resourcemanager</artifactId>
<version><SDK_VERSION></version>
<scope>compile</scope>
</dependency>
```

```shell
./gradlew publishToMavenLocal
### Gradle users

Add this dependency to your project's build file:

```groovy
repositories {
mavenCentral()
}

dependencies {
implementation "cloud.stackit.sdk:resourcemanager:<SDK_VERSION>"
}
```

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
## Installation from local build

Building the API client library requires:
1. Java SDK (version 11 to 21 should be supported) installed on your system

To install the API client library to your local Maven repository, simply execute:

```shell
# TODO: follow up story
# ./gradlew publishToMavenCentral
./gradlew services:resourcemanager:publishToMavenLocal
```

Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.

### Maven users

Add this dependency to your project's POM:

```xml
<dependency>
<groupId>cloud.stackit</groupId>
<artifactId>stackit-sdk-resourcemanager</artifactId>
<groupId>cloud.stackit.sdk</groupId>
<artifactId>resourcemanager</artifactId>
<version><SDK_VERSION></version>
<scope>compile</scope>
</dependency>
Expand All @@ -72,33 +89,18 @@ Add this dependency to your project's build file:

```groovy
repositories {
mavenCentral() // Needed if the 'stackit-sdk-resourcemanager' jar has been published to maven central.
mavenLocal() // Needed if the 'stackit-sdk-resourcemanager' jar has been published to the local maven repo.
mavenLocal()
}

dependencies {
implementation "cloud.stackit:stackit-sdk-resourcemanager:<SDK_VERSION>"
implementation "cloud.stackit.sdk:resourcemanager:<SDK_VERSION>"
}
```

### Others

At first generate the JAR by executing:

```shell
mvn clean package
```

Then manually install the following JARs:

- `target/stackit-sdk-resourcemanager-<SDK_VERSION>.jar`
- `target/lib/*.jar`

## Getting Started

See the [resourcemanager examples](https://github.com/stackitcloud/stackit-sdk-java/tree/main/examples/resourcemanager/src/main/java/cloud/stackit/sdk/resourcemanager/examples).


## Recommendation

It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.