cdktf-provider-oci 0.0.0

CDKTF bindings for Oracle Cloud Infrastructure

CDKTF Provider for Oracle Cloud Infrastructure (OCI)

This repository contains auto-generated CDKTF (Cloud Development Kit for Terraform) bindings for Oracle Cloud Infrastructure.

Features

• 🚀 Auto-generated bindings from the official OCI Terraform provider
• 📦 Multi-language support (TypeScript/JavaScript and Python)
• 🔄 Automated updates via GitHub Actions when new OCI provider versions are released
• 📝 Type-safe infrastructure code with full IDE support
• 🎯 Automated publishing to NPM and PyPI registries

Installation

TypeScript/JavaScript

npm install @cdktf/provider-oci
# or
yarn add @cdktf/provider-oci

Python

pip install cdktf-provider-oci

Quick Start

TypeScript Example

import { Construct } from 'constructs';
import { App, TerraformStack } from 'cdktf';
import { OciProvider } from '@cdktf/provider-oci/lib/provider';
import { Instance } from '@cdktf/provider-oci/lib/instance';

class MyStack extends TerraformStack {
  constructor(scope: Construct, name: string) {
    super(scope, name);

    new OciProvider(this, 'oci', {
      region: 'us-ashburn-1',
      tenancyOcid: process.env.OCI_TENANCY_OCID,
      userOcid: process.env.OCI_USER_OCID,
      fingerprint: process.env.OCI_FINGERPRINT,
      privateKey: process.env.OCI_PRIVATE_KEY,
    });

    new Instance(this, 'example', {
      availabilityDomain: 'AD-1',
      compartmentId: process.env.OCI_COMPARTMENT_ID,
      shape: 'VM.Standard.E2.1.Micro',
      // ... other configuration
    });
  }
}

const app = new App();
new MyStack(app, 'oci-example');
app.synth();

Python Example

from constructs import Construct
from cdktf import App, TerraformStack
from cdktf_provider_oci import OciProvider, Instance

class MyStack(TerraformStack):
    def __init__(self, scope: Construct, name: str):
        super().__init__(scope, name)

        OciProvider(self, "oci",
            region="us-ashburn-1",
            tenancy_ocid=os.environ["OCI_TENANCY_OCID"],
            user_ocid=os.environ["OCI_USER_OCID"],
            fingerprint=os.environ["OCI_FINGERPRINT"],
            private_key=os.environ["OCI_PRIVATE_KEY"]
        )

        Instance(self, "example",
            availability_domain="AD-1",
            compartment_id=os.environ["OCI_COMPARTMENT_ID"],
            shape="VM.Standard.E2.1.Micro"
            # ... other configuration
        )

app = App()
MyStack(app, "oci-example")
app.synth()

Development

Prerequisites

• Node.js 18+
• Yarn
• Python 3.8+ (for Python bindings)

Setup

# Install dependencies
yarn install

# Generate provider bindings
./scripts/generate-provider.sh

# Run tests
yarn test

# Build the project
yarn build

Project Structure

.
├── src/              # Source code for custom constructs
├── lib/              # Compiled JavaScript code
├── dist/             # Distribution packages
├── .gen/             # Generated provider bindings
├── scripts/          # Utility scripts
└── test/             # Test files

GitHub Actions Automation

This repository includes automated workflows:

1. Daily Provider Updates: Checks for new OCI provider versions and creates PRs
2. Build & Test: Runs on every push and pull request
3. Release: Automatically publishes to NPM and PyPI on version tags
4. Generate Bindings: Can be triggered manually to regenerate provider bindings

Setting up GitHub Secrets

To enable automated publishing, configure these secrets in your GitHub repository:

• NPM_TOKEN: NPM automation token for publishing
• TWINE_USERNAME: PyPI username (use __token__ for API tokens)
• TWINE_PASSWORD: PyPI password or API token

See GITHUB_SECRETS_SETUP.md for detailed instructions.

Version Management

This project follows semantic versioning. The OCI provider version is tracked separately in provider-config.json.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the Apache-2.0 License - see the LICENSE file for details.

Resources

• OCI Terraform Provider Documentation
• CDKTF Documentation
• Oracle Cloud Infrastructure Documentation

Support

For issues and questions:

• Open an issue in this repository
• Check existing issues for solutions
• Refer to the official OCI and CDKTF documentation