Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/virtuslabrnd/pulumi-kotlin
Experimental support for Kotlin language in Pulumi
https://github.com/virtuslabrnd/pulumi-kotlin
aws azure cloud cloud-computing gcp google-cloud iac infrastructure-as-code java kotlin kubernetes pulumi
Last synced: 16 days ago
JSON representation
Experimental support for Kotlin language in Pulumi
- Host: GitHub
- URL: https://github.com/virtuslabrnd/pulumi-kotlin
- Owner: VirtuslabRnD
- License: apache-2.0
- Created: 2022-08-31T11:48:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-30T11:09:08.000Z (25 days ago)
- Last Synced: 2025-01-02T23:36:41.283Z (21 days ago)
- Topics: aws, azure, cloud, cloud-computing, gcp, google-cloud, iac, infrastructure-as-code, java, kotlin, kubernetes, pulumi
- Language: Kotlin
- Homepage:
- Size: 5.46 MB
- Stars: 62
- Watchers: 5
- Forks: 3
- Open Issues: 65
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Pulumi Kotlin SDK
Experimental support for Kotlin language in [Pulumi](https://www.pulumi.com/).
**This is a proof of concept.** [We really need your feedback](#giving-feedback) before adding more features, improving
the code and integrating with the Pulumi ecosystem.
## Navigation
- [Articles and talks](#articles-and-talks)
- [Code examples](#code-examples)
- [Getting started](#getting-started)
- [Supported providers](#supported-providers)
- [Giving feedback](#giving-feedback)
- [Development docs](#development-docs)
## Articles and talks
- [Pulumi Kotlin. The missing piece in Kotlin multi-platform](https://medium.com/virtuslab/pulumi-kotlin-9c0cb2d53e1c) by [@jplewa](https://github.com/jplewa)
- [Infrastructure as code done right with JVM](https://2023.javazone.no/program/444fd903-4857-4591-b0c2-a824ccf5d3af) by [@lbialy](https://github.com/lbialy)
## Code examples
> ℹ️ You can find more examples [here][pulumi-kotlin-code-examples].
### Provisioning a virtual machine on Google Cloud Platform
```kotlin
import com.pulumi.gcp.compute.kotlin.ComputeFunctions
import com.pulumi.gcp.compute.kotlin.instance
import com.pulumi.kotlin.Pulumi
fun main() {
Pulumi.run { ctx ->
val debianImage = ComputeFunctions.getImage {
family("debian-11")
project("debian-cloud")
}
val instance = instance("gcp-sample-instance") {
args {
machineType("e2-micro")
zone("europe-central2-a")
tags("foo", "bar")
bootDisk {
autoDelete(true)
initializeParams {
image(debianImage.name)
}
}
networkInterfaces {
network("default")
}
metadata("foo" to "bar")
metadataStartupScript("echo hi > /test.txt")
serviceAccount {
scopes("cloud-platform")
}
}
}
ctx.export("instanceName", instance.name)
}
}
```
### Provisioning a virtual machine on Azure
```kotlin
import com.pulumi.azurenative.compute.kotlin.enums.CachingTypes.ReadWrite
import com.pulumi.azurenative.compute.kotlin.enums.DiskCreateOptionTypes.FromImage
import com.pulumi.azurenative.compute.kotlin.enums.DiskDeleteOptionTypes.Delete
import com.pulumi.azurenative.network.kotlin.enums.IPAllocationMethod.Dynamic
import com.pulumi.azurenative.compute.kotlin.enums.StorageAccountTypes.Standard_LRS
import com.pulumi.azurenative.compute.kotlin.enums.VirtualMachineSizeTypes.Standard_B1s
import com.pulumi.azurenative.compute.kotlin.virtualMachine
import com.pulumi.azurenative.network.kotlin.networkInterface
import com.pulumi.azurenative.network.kotlin.subnet
import com.pulumi.azurenative.network.kotlin.virtualNetwork
import com.pulumi.azurenative.resources.kotlin.resourceGroup
import com.pulumi.kotlin.Pulumi
fun main() {
Pulumi.run { ctx ->
val resourceGroup = resourceGroup("azure-native-sample-vm")
val mainVirtualNetwork = virtualNetwork("virtual-network") {
args {
resourceGroupName(resourceGroup.name)
addressSpace {
addressPrefixes("10.0.0.0/16")
}
}
}
val internalSubnet = subnet("internal-subnet") {
args {
resourceGroupName(resourceGroup.name)
virtualNetworkName(mainVirtualNetwork.name)
addressPrefix("10.0.2.0/24")
}
}
val mainNetworkInterface = networkInterface("network-interface") {
args {
resourceGroupName(resourceGroup.name)
ipConfigurations {
name("testconfiguration1")
subnet {
id(internalSubnet.id)
}
privateIPAllocationMethod(Dynamic)
}
}
}
val virtualMachine = virtualMachine("virtual-machine") {
args {
resourceGroupName(resourceGroup.name)
networkProfile {
networkInterfaces {
id(mainNetworkInterface.id)
}
}
hardwareProfile {
vmSize(Standard_B1s)
}
storageProfile {
imageReference {
publisher("Canonical")
offer("UbuntuServer")
sku("16.04-LTS")
version("latest")
}
osDisk {
name("myosdisk1")
caching(ReadWrite)
createOption(FromImage)
managedDisk {
storageAccountType(Standard_LRS)
}
deleteOption(Delete)
}
}
osProfile {
computerName("hostname")
adminUsername("testadmin")
adminPassword("testpassword")
}
}
}
ctx.export("virtualMachineId", virtualMachine.id)
}
}
```
### Creating a Kubernetes deployment
```kotlin
import com.pulumi.kotlin.Pulumi
import com.pulumi.kubernetes.apps.v1.kotlin.deployment
fun main() {
Pulumi.run { ctx ->
val deployment = deployment("nginx") {
args {
spec {
selector {
matchLabels("app" to "nginx")
}
replicas(1)
template {
metadata {
labels("app" to "nginx")
}
spec {
containers {
name("nginx")
image("nginx")
ports {
containerPort(80)
}
}
}
}
}
}
}
val name = deployment.metadata?.applyValue { it.name.orEmpty() }
ctx.export("name", name)
}
}
```
## Getting started
#### 1. Install Pulumi.
To install the latest Pulumi release, run the following
(see full [installation instructions][pulumi-installation-guide] for additional installation options):
```bash
$ curl -fsSL https://get.pulumi.com/ | sh
```
#### 2. Create a Pulumi project.
> ⚠️ There are no Kotlin-specific templates for `pulumi new` yet. You need to use Java templates (e.g. `aws-java`).
To create a new Pulumi project, you need to use the `pulumi new` command.
##### Maven
```bash
$ mkdir pulumi-kotlin-demo && cd pulumi-kotlin-demo
$ pulumi new aws-java
```
##### Gradle
```bash
$ mkdir pulumi-kotlin-demo && cd pulumi-kotlin-demo
$ pulumi new https://github.com/myhau/pulumi-templates/tree/add-template-for-java-gradle-with-kotlin-dsl/java-gradle-kts
```
#### 3. Add new or replace existing dependencies
> ℹ️ See [the section below](#supported-providers) for the full list of supported providers along with docs.
##### Maven
Copy the `dependency` block from [the table below (Supported providers)](#supported-providers) and paste it to your
`pom.xml`. For example:
```xml
org.virtuslab
pulumi-google-native-kotlin
0.31.0.0
```
Any existing Java-specific dependency can be replaced with its Kotlin-specific equivalent. For example:
```xml
com.pulumi
aws
5.42.0
```
can be replaced with:
```xml
org.virtuslab
pulumi-aws-kotlin
5.42.0.0
```
Similarly, when it comes to the base Pulumi dependency, you can replace this:
```xml
com.pulumi
pulumi
0.11.0
```
with this:
```xml
org.virtuslab
pulumi-kotlin
0.11.0.0
```
##### Gradle
Copy the dependency from [the table below (Supported providers)](#supported-providers) and paste it to your
`build.gradle.kts`. For example:
```kt
implementation("org.virtuslab:pulumi-google-native-kotlin:0.31.0.0")
```
Any existing Java-specific dependency can be replaced with its Kotlin-specific equivalent. For example:
```kt
implementation("com.pulumi.aws:5.42.0")
```
can be replaced with:
```kt
implementation("org.virtuslab.pulumi-aws-kotlin:5.42.0.0")
```
Similarly, when it comes to the base Pulumi dependency, you can replace this:
```kt
implementation("com.pulumi:pulumi:0.11.0")
```
with this:
```kt
implementation("org.virtuslab:pulumi-kotlin:0.11.0.0")
```
#### 4. Read the docs.
> ⚠️ For now, docs viewable in your text editor (and Kotlin API docs hosted [here][google-native-kdoc])
> only include Java SDK example snippets.
Using IntelliJ is heavily recommended as it can guide you through type-safe Kotlin DSLs.
Additionally, there are two sources of documentation:
- Pulumi official docs (example for [`google-native`][google-native-registry-docs])
- Kotlin API docs (example for [`google-native`][google-native-kdoc])
#### 5. Write the code.
Write the code that describes your resources:
```kotlin
import com.pulumi.kotlin.Pulumi
fun main() {
Pulumi.run { ctx ->
// your resources
}
}
```
For inspiration, see the
["Provisioning a virtual machine on Google Cloud Platform"](#provisioning-a-virtual-machine-on-google-cloud-platform)
example above (it's from Pulumi Java docs for Google Native provider, rewritten to Pulumi Kotlin).
#### 6. Deploy to the cloud.
Run `pulumi up`. This provisions all cloud resources declared in your code.
## Supported providers
The table below lists the providers that are currently supported by Pulumi Kotlin SDK. A full list of all Pulumi
providers can be found [here][pulumi-registry].
These Kotlin libraries serve as a wrapper on top of corresponding Java libraries.
For convenience, they follow the same versioning pattern with an additional `KOTLIN-PATCH` version
number (`MAJOR.MINOR.PATCH.KOTLIN-PATCH`). For example, version `5.16.2.0` of Pulumi Kotlin AWS provider is a wrapper on
top of version `5.16.2` of Pulumi Java AWS provider.
If the additional index is incremented (e.g. to `5.16.2.1`), it means that some updates were made to our generator and
that the Kotlin code has been improved, but the underlying Java library remained the same.
[//]: # (This table is generated automatically during releases, don't alter it manually unless absolutely necessary.)
Name
Version
Maven artifact
Gradle artifact
Maven Central
Pulumi official docs
Kotlin API docs
cloudflare
4.16.0.2
```xml
org.virtuslab
pulumi-cloudflare-kotlin
4.16.0.2
```
```kt
implementation("org.virtuslab:pulumi-cloudflare-kotlin:4.16.0.2")
```
link
link
link
cloudflare
5.46.0.0
```xml
org.virtuslab
pulumi-cloudflare-kotlin
5.46.0.0
```
```kt
implementation("org.virtuslab:pulumi-cloudflare-kotlin:5.46.0.0")
```
link
link
link
slack
0.4.10.0
```xml
org.virtuslab
pulumi-slack-kotlin
0.4.10.0
```
```kt
implementation("org.virtuslab:pulumi-slack-kotlin:0.4.10.0")
```
link
link
link
github
5.26.0.1
```xml
org.virtuslab
pulumi-github-kotlin
5.26.0.1
```
```kt
implementation("org.virtuslab:pulumi-github-kotlin:5.26.0.1")
```
link
link
link
github
6.5.0.0
```xml
org.virtuslab
pulumi-github-kotlin
6.5.0.0
```
```kt
implementation("org.virtuslab:pulumi-github-kotlin:6.5.0.0")
```
link
link
link
random
4.16.8.0
```xml
org.virtuslab
pulumi-random-kotlin
4.16.8.0
```
```kt
implementation("org.virtuslab:pulumi-random-kotlin:4.16.8.0")
```
link
link
link
gcp
6.67.1.1
```xml
org.virtuslab
pulumi-gcp-kotlin
6.67.1.1
```
```kt
implementation("org.virtuslab:pulumi-gcp-kotlin:6.67.1.1")
```
link
link
link
gcp
7.38.0.0
```xml
org.virtuslab
pulumi-gcp-kotlin
7.38.0.0
```
```kt
implementation("org.virtuslab:pulumi-gcp-kotlin:7.38.0.0")
```
link
link
link
gcp
8.12.1.0
```xml
org.virtuslab
pulumi-gcp-kotlin
8.12.1.0
```
```kt
implementation("org.virtuslab:pulumi-gcp-kotlin:8.12.1.0")
```
link
link
link
google-native
0.31.1.2
```xml
org.virtuslab
pulumi-google-native-kotlin
0.31.1.2
```
```kt
implementation("org.virtuslab:pulumi-google-native-kotlin:0.31.1.2")
```
link
link
link
aws
5.43.0.1
```xml
org.virtuslab
pulumi-aws-kotlin
5.43.0.1
```
```kt
implementation("org.virtuslab:pulumi-aws-kotlin:5.43.0.1")
```
link
link
link
aws
6.66.2.0
```xml
org.virtuslab
pulumi-aws-kotlin
6.66.2.0
```
```kt
implementation("org.virtuslab:pulumi-aws-kotlin:6.66.2.0")
```
link
link
link
aws-native
0.126.0.0
```xml
org.virtuslab
pulumi-aws-native-kotlin
0.126.0.0
```
```kt
implementation("org.virtuslab:pulumi-aws-native-kotlin:0.126.0.0")
```
link
link
link
aws-native
1.20.0.0
```xml
org.virtuslab
pulumi-aws-native-kotlin
1.20.0.0
```
```kt
implementation("org.virtuslab:pulumi-aws-native-kotlin:1.20.0.0")
```
link
link
link
azure
5.87.0.0
```xml
org.virtuslab
pulumi-azure-kotlin
5.87.0.0
```
```kt
implementation("org.virtuslab:pulumi-azure-kotlin:5.87.0.0")
```
link
link
link
azure
6.14.0.0
```xml
org.virtuslab
pulumi-azure-kotlin
6.14.0.0
```
```kt
implementation("org.virtuslab:pulumi-azure-kotlin:6.14.0.0")
```
link
link
link
azure-native
1.104.0.2
```xml
org.virtuslab
pulumi-azure-native-kotlin
1.104.0.2
```
```kt
implementation("org.virtuslab:pulumi-azure-native-kotlin:1.104.0.2")
```
link
link
link
azure-native
2.80.0.0
```xml
org.virtuslab
pulumi-azure-native-kotlin
2.80.0.0
```
```kt
implementation("org.virtuslab:pulumi-azure-native-kotlin:2.80.0.0")
```
link
link
link
kubernetes
3.30.2.2
```xml
org.virtuslab
pulumi-kubernetes-kotlin
3.30.2.2
```
```kt
implementation("org.virtuslab:pulumi-kubernetes-kotlin:3.30.2.2")
```
link
link
link
kubernetes
4.19.0.0
```xml
org.virtuslab
pulumi-kubernetes-kotlin
4.19.0.0
```
```kt
implementation("org.virtuslab:pulumi-kubernetes-kotlin:4.19.0.0")
```
link
link
link
nomad
0.4.1.2
```xml
org.virtuslab
pulumi-nomad-kotlin
0.4.1.2
```
```kt
implementation("org.virtuslab:pulumi-nomad-kotlin:0.4.1.2")
```
link
link
link
nomad
2.4.1.0
```xml
org.virtuslab
pulumi-nomad-kotlin
2.4.1.0
```
```kt
implementation("org.virtuslab:pulumi-nomad-kotlin:2.4.1.0")
```
link
link
link
docker
3.6.1.3
```xml
org.virtuslab
pulumi-docker-kotlin
3.6.1.3
```
```kt
implementation("org.virtuslab:pulumi-docker-kotlin:3.6.1.3")
```
link
link
link
docker
4.5.8.0
```xml
org.virtuslab
pulumi-docker-kotlin
4.5.8.0
```
```kt
implementation("org.virtuslab:pulumi-docker-kotlin:4.5.8.0")
```
link
link
link
gitlab
4.10.0.2
```xml
org.virtuslab
pulumi-gitlab-kotlin
4.10.0.2
```
```kt
implementation("org.virtuslab:pulumi-gitlab-kotlin:4.10.0.2")
```
link
link
link
gitlab
5.0.2.2
```xml
org.virtuslab
pulumi-gitlab-kotlin
5.0.2.2
```
```kt
implementation("org.virtuslab:pulumi-gitlab-kotlin:5.0.2.2")
```
link
link
link
gitlab
6.11.0.1
```xml
org.virtuslab
pulumi-gitlab-kotlin
6.11.0.1
```
```kt
implementation("org.virtuslab:pulumi-gitlab-kotlin:6.11.0.1")
```
link
link
link
gitlab
7.0.2.0
```xml
org.virtuslab
pulumi-gitlab-kotlin
7.0.2.0
```
```kt
implementation("org.virtuslab:pulumi-gitlab-kotlin:7.0.2.0")
```
link
link
link
gitlab
8.7.0.0
```xml
org.virtuslab
pulumi-gitlab-kotlin
8.7.0.0
```
```kt
implementation("org.virtuslab:pulumi-gitlab-kotlin:8.7.0.0")
```
link
link
link
digitalocean
4.37.1.0
```xml
org.virtuslab
pulumi-digitalocean-kotlin
4.37.1.0
```
```kt
implementation("org.virtuslab:pulumi-digitalocean-kotlin:4.37.1.0")
```
link
link
link
alicloud
3.72.0.0
```xml
org.virtuslab
pulumi-alicloud-kotlin
3.72.0.0
```
```kt
implementation("org.virtuslab:pulumi-alicloud-kotlin:3.72.0.0")
```
link
link
link
keycloak
5.4.0.0
```xml
org.virtuslab
pulumi-keycloak-kotlin
5.4.0.0
```
```kt
implementation("org.virtuslab:pulumi-keycloak-kotlin:5.4.0.0")
```
link
link
link
vault
6.4.0.0
```xml
org.virtuslab
pulumi-vault-kotlin
6.4.0.0
```
```kt
implementation("org.virtuslab:pulumi-vault-kotlin:6.4.0.0")
```
link
link
link
## Giving feedback
Pulumi Kotlin SDK is a proof of concept, **we really need feedback before moving on**.
- Create [an issue in this repo][issues-pulumi-kotlin] or express your opinion in the
existing ["Support for idiomatic Kotlin"][support-for-idiomatic-kotlin-issue] issue.
- Start a thread on [#java channel][pulumi-slack-java-channel] (Pulumi community Slack).
- Book a meeting [through Calendly][calendly-feedback-meeting] and let's talk!
## Development docs
- [Code generation and local run details](docs/code-generation.md)
- [Development guidelines](docs/development-guidelines.md)
[pulumi-kotlin-code-examples]: https://github.com/VirtuslabRnD/pulumi-kotlin/tree/main/examples
[pulumi-kotlin-issue-197]: https://github.com/VirtuslabRnD/pulumi-kotlin/issues/197
[pulumi-installation-guide]: https://www.pulumi.com/docs/reference/install/?utm_campaign=pulumi-pulumi-github-repo&utm_source=github.com&utm_medium=getting-started-install
[google-native-kdoc]: https://storage.googleapis.com/pulumi-kotlin-docs/google-native/0.31.1.0/index.html
[google-native-registry-docs]: https://www.pulumi.com/registry/packages/google-native
[pulumi-registry]: https://www.pulumi.com/registry
[issues-pulumi-kotlin]: https://github.com/VirtuslabRnD/pulumi-kotlin/issues
[support-for-idiomatic-kotlin-issue]: https://github.com/pulumi/pulumi-java/issues/544
[pulumi-slack-java-channel]: https://pulumi-community.slack.com/archives/C03DPAY96NB
[calendly-feedback-meeting]: https://calendly.com/michalfudala/kotlin-sdk-for-pulumi-feedback