Skip to content

Commit 35846ff

Browse files
Generate iaas (#23)
1 parent 320284e commit 35846ff

File tree

1 file changed

+36
-34
lines changed

1 file changed

+36
-34
lines changed

services/iaas/README.md

Lines changed: 36 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
# stackit-sdk-iaas
2-
3-
IaaS-API
1+
# STACKIT Java SDK for IaaS-API
42

53
- API version: 1
64

@@ -10,37 +8,56 @@ For more information, please visit [https://support.stackit.cloud/servicedesk](h
108

119
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.
1210

11+
## Installation from Maven Central (recommended)
1312

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

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

19-
## Installation
17+
Add this dependency to your project's POM:
2018

21-
To install the API client library to your local Maven repository, simply execute:
19+
```xml
20+
<dependency>
21+
<groupId>cloud.stackit.sdk</groupId>
22+
<artifactId>iaas</artifactId>
23+
<version><SDK_VERSION></version>
24+
<scope>compile</scope>
25+
</dependency>
26+
```
2227

23-
```shell
24-
./gradlew publishToMavenLocal
28+
### Gradle users
29+
30+
Add this dependency to your project's build file:
31+
32+
```groovy
33+
repositories {
34+
mavenCentral()
35+
}
36+
37+
dependencies {
38+
implementation "cloud.stackit.sdk:iaas:<SDK_VERSION>"
39+
}
2540
```
2641

27-
To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:
42+
## Installation from local build
43+
44+
Building the API client library requires:
45+
1. Java SDK (version 11 to 21 should be supported) installed on your system
46+
47+
To install the API client library to your local Maven repository, simply execute:
2848

2949
```shell
30-
# TODO: follow up story
31-
# ./gradlew publishToMavenCentral
50+
./gradlew services:iaas:publishToMavenLocal
3251
```
3352

34-
Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information.
35-
3653
### Maven users
3754

3855
Add this dependency to your project's POM:
3956

4057
```xml
4158
<dependency>
42-
<groupId>cloud.stackit</groupId>
43-
<artifactId>stackit-sdk-iaas</artifactId>
59+
<groupId>cloud.stackit.sdk</groupId>
60+
<artifactId>iaas</artifactId>
4461
<version><SDK_VERSION></version>
4562
<scope>compile</scope>
4663
</dependency>
@@ -52,33 +69,18 @@ Add this dependency to your project's build file:
5269

5370
```groovy
5471
repositories {
55-
mavenCentral() // Needed if the 'stackit-sdk-iaas' jar has been published to maven central.
56-
mavenLocal() // Needed if the 'stackit-sdk-iaas' jar has been published to the local maven repo.
72+
mavenLocal()
5773
}
5874
5975
dependencies {
60-
implementation "cloud.stackit:stackit-sdk-iaas:<SDK_VERSION>"
76+
implementation "cloud.stackit.sdk:iaas:<SDK_VERSION>"
6177
}
6278
```
6379

64-
### Others
65-
66-
At first generate the JAR by executing:
67-
68-
```shell
69-
mvn clean package
70-
```
71-
72-
Then manually install the following JARs:
73-
74-
- `target/stackit-sdk-iaas-<SDK_VERSION>.jar`
75-
- `target/lib/*.jar`
76-
7780
## Getting Started
7881

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

81-
8284
## Recommendation
8385

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

0 commit comments

Comments
 (0)