RHOAS Core SDKs
If you are moving a project from the old RHOAS SDKs to core read this moving doc to get started.
| Supported Langauge | SDK |
|---|---|
| JavaScript | app-services-sdk-ts |
| Python | app-services-sdk-python |
| Java | app-services-sdk-java |
| Go | app-services-sdk-go |
Structure
RHOAS SDK's are delivered as set of individual packages. SDK's are divided into two types:
- Management SDKs - support creating services
- Instance SDKs - support direct interaction with services
Purpose of this repository
Repository contains source code for openapi based generator along with automation scripts that generate all underlying RHOAS SDKS.
RHOAS SDK for Typescript
Typescript packages and API clients for RHOAS services
Prequisites
- NodeJS 14.x lts or above
Management SDK's
| Name | Package name | Status | Version | NPM | Docs |
|---|---|---|---|---|---|
| kafka | @rhoas/kafka-management-sdk | beta | npm | doc | |
| service-accounts | @rhoas/service-accounts-sdk | alpha | npm | doc | |
| connector | @rhoas/connector-management-sdk | alpha | npm | doc | |
| service registry | @rhoas/registry-management-sdk | alpha | npm | doc | |
| smart events | @rhoas/smart-events-management-sdk | alpha | npm | doc |
Instances SDK's
| Name | Package name | Status | Version | NPM | Docs |
|---|---|---|---|---|---|
| kafka | @rhoas/kafka-instance-sdk | beta | npm | doc | |
| service registry | @rhoas/registry-instance-sdk | beta | npm | doc |
Docs
Examples
RHOAS SDK for Python
Python packages and API clients for Red Had OpenShift Application Services (RHOAS)
Prequisites
- Python 3.9 or above
- pip for installing packages
Installation
Currently all RHOAS SDKs are bundled together. To install the RHOAS SDK with the pip package installer:
$ python -m pip install rhoas-sdks
RHOAS App Services SDK for Python
All packages are now available and can be accessed by just importing them as shown below:
| API | Status | Package |
|---|---|---|
| KafkaManagement | beta | import python rhoas_kafka_mgmt_sdk |
| ServiceRegistryManagement | alpha | import rhoas_service_registry_mgmt_sdk |
| ConnectorManagement | alpha | import rhoas_connector_mgmt_sdk |
| ServiceAccounts | alpha | import rhoas_service_accounts_mgmt_sdk |
Instances SDKs
| API | Status | Package |
|---|---|---|
| KafkaInstance | beta | import rhoas_kafka_instance_sdk |
| RegistryInstance | beta | import rhoas_registry_instance_sdk |
Documentation
Examples
RHOAS SDK for Java
Java packages and API clients for RHOAS services
Prequisites
- Maven 3.6.x or above
Management SDK's
| Name | Artifact Id | Status | Version | Package | Docs |
|---|---|---|---|---|---|
| kafka | kafka-management-sdk | beta | 1.1.2 | info | doc |
| service accounts | service-accounts-sdk | alpha | 1.1.2 | info | doc |
| service registry | registry-management-sdk | alpha | 0.0.6 | info | doc |
| connector-management | connector-management-sdk | alpha | 0.0.6 | info | doc |
| smart-events-management | smart-events-management-sdk | alpha | 0.0.6 | info | doc |
Instances SDK's
| Name | Package name | Status | Version | Package | Docs |
|---|---|---|---|---|---|
| kafka | kafka-instance-sdk | beta | 1.1.2 | info | doc |
| service registry | TBA | TBA | TBA | TBA | TBA |
Docs
RHOAS SDK for Go
Go packages and API clients for Red Hat OpenShift Application Services (RHOAS)
Prequisites
- Go 1.15 or above
Installation
Install the RHOAS SDK with go get:
$ go get github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go
Import:
import "github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go"
Management SDKs
| API | Status | Package |
|---|---|---|
| KafkaManagement | beta | github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go/kafkamgmt/apiv1 |
| Service Account Management | alpha | github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go/serviceaccountmgmt/apiv1 |
| ServiceRegistryManagement | alpha | github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go/registrymgmt/apiv1 |
| ConnectorManagement | alpha | github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go/connectormgmt/apiv1 |
Instances SDKs
| API | Status | Package |
|---|---|---|
| KafkaInstance | beta | github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go/kafkainstance/apiv1 |
| RegistryInstance | beta | github.com/redhat-developer/app-services-sdk-core/app-services-sdk-go/registryinstance/apiv1internal |
Documentation
Examples
Metadata
Release files for rhoas-sdks 1.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| rhoas_sdks-1.0.5.tar.gz | 417.8 kB | Without provenance | Details for rhoas_sdks-1.0.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| rhoas_sdks-1.0.5-py3-none-any.whl | Python 3 | none | any | Details for rhoas_sdks-1.0.5-py3-none-any.whl |
Total release size: 1.6 MB
Release files / rhoas_sdks-1.0.5.tar.gz
| Download URL | rhoas_sdks-1.0.5.tar.gz |
|---|---|
| Size | 417.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d77fa311a1666f5f8985f2fad6d724e8b095e65ae840349222d1e7abc47ae0a2
|
|
BLAKE2b-256 checksum How to use checksums |
69f981eecbe6ed145a122bd62afdd2820785a4423068251bfc2953c0691e8110
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.4
|
Release files / rhoas_sdks-1.0.5-py3-none-any.whl
| Download URL | rhoas_sdks-1.0.5-py3-none-any.whl |
|---|---|
| Size | 1.1 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2a9d0e2ad009960bb4825fb974f983ed37a84408a905f6111f0d1604dd0bf2d4
|
|
BLAKE2b-256 checksum How to use checksums |
ee3934b3fc7a9ec1c61fa6e4cbf4c59334eeee9ade386a587f1de794050e6ca6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.11.4
|
Security for rhoas-sdks 1.0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.