@mikarinneoracle/oci-cdk-code-only-preview 0.0.1 → 0.0.3

package/README.md

@@ -86,10 +86,17 @@ Only **`OCI_COMPARTMENT_ID`** (or `OCI_COMPARTMENT_OCID`) is required for deploy
 
 ### Using an OCI CLI preview installation
 
-Choose a non-default CLI executable without changing your shell `PATH`:
+Choose a non-default CLI executable without changing your shell `PATH`. `OCI_CLI_PATH` must be the absolute path to the preview binary, not merely the directory containing it:
 
 ```bash
-export OCI_CLI_PATH="$PWD/.tools/oci-preview-bin/oci"
+export OCI_CLI_PATH="/absolute/path/to/oci-preview-bin/oci"
+"$OCI_CLI_PATH" --version
+```
+
+For the repository-local preview installation used in this checkout:
+
+```bash
+export OCI_CLI_PATH="/Users/MRINNE/projects/ocdk/.tools/oci-preview-bin/oci"
 ```
 
 The repository-local preview installation is required only for preview-only features such as Code-only Functions. Regular deployments continue to use `oci` from `PATH` unless `OCI_CLI_PATH` is set.
@@ -101,15 +108,31 @@ Code-only deployment first uses Terraform to create or manage the Function Appli
 Activate the path with either `-code-only`, `--code-only`, or `OCI_CODE_ONLY=1`. The compatibility environment key `code-only=1` is also recognized when a process launcher can set a hyphenated environment name.
 
 ```bash
-export OCI_CLI_PATH="$PWD/.tools/oci-preview-bin/oci"
+# Required: OCI CLI preview binary
+export OCI_CLI_PATH="/Users/MRINNE/projects/ocdk/.tools/oci-preview-bin/oci"
+"$OCI_CLI_PATH" --version
+
+# Required: OCI target
 export OCI_COMPARTMENT_ID='ocid1.compartment.oc1...'
-export OCI_FUNCTION_APP_NAME='hello-arm'
-export OCI_FUNCTION_NAME='my-function'
+
+# Required: code-only runtime and handler
 export OCI_CODE_ONLY_RUNTIME_NAME='python312.ol9'
 export OCI_FUNCTION_HANDLER='func.handler'
-npx ocdk deploy --code-only
+
+# Required in func.yaml: name: my-function
+# Terraform creates the Function App; OCI CLI preview uploads the ZIP function
+npx ocdk deploy --auto-approve --code-only
 ```
 
+By default, the function name and Function App name both come from `func.yaml`'s `name`. Set these only to override that default or to use a differently named existing Function App:
+
+```bash
+export OCI_FUNCTION_NAME='my-function'
+export OCI_FUNCTION_APP_NAME='my-existing-function-app'
+```
+
+These settings are optional: `OCI_CODE_ONLY_SOURCE_DIR` (defaults to the current directory), `OCI_FUNCTION_MEMORY_MB` (from `func.yaml`, otherwise `256`), and `OCI_FUNCTION_TIMEOUT_SECONDS` (from `func.yaml`, otherwise `30`). `OCI_TENANCY_ID`, `OCI_REGION`, and `OCI_NAMESPACE` are also optional when they can be resolved from the active OCI CLI profile.
+
 The archive is built from `OCI_CODE_ONLY_SOURCE_DIR` (or the current directory). It includes source files and excludes `node_modules`, `.git`, `.tools`, `.terraform`, and `cdktf.out`. The current preview path is function-only: it does not create an API Gateway because the CLI-managed function OCID is not in Terraform state.
 
 Use the same flag or environment variable for deletion. OCDK deletes the CLI-managed function first, then lets Terraform destroy the Function App and its infrastructure:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikarinneoracle/oci-cdk-code-only-preview",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "OCI CDK stack for OCI Functions, API Gateway, and related infrastructure",
   "main": "lib/index.js",
   "bin": {

package/lib/.gen/providers/oci/identity-dynamic-group/index.d.ts

@@ -1,166 +0,0 @@
-import { Construct } from 'constructs';
-import * as cdktf from 'cdktf';
-export interface IdentityDynamicGroupConfig extends cdktf.TerraformMetaArguments {
-    /**
-    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/oci/5.47.0/docs/resources/identity_dynamic_group#compartment_id IdentityDynamicGroup#compartment_id}
-    */
-    readonly compartmentId: string;
-    /**
-    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/oci/5.47.0/docs/resources/identity_dynamic_group#defined_tags IdentityDynamicGroup#defined_tags}
-    */
-    readonly definedTags?: {
-        [key: string]: string;
-    };
-    /**
-    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/oci/5.47.0/docs/resources/identity_dynamic_group#description IdentityDynamicGroup#description}
-    */
-    readonly description: string;
-    /**
-    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/oci/5.47.0/docs/resources/identity_dynamic_group#freeform_tags IdentityDynamicGroup#freeform_tags}
-    */
-    readonly freeformTags?: {
-        [key: string]: string;
-    };
-    /**
-    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/oci/5.47.0/docs/resources/identity_dynamic_group#id IdentityDynamicGroup#id}
-    *
-    * Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
-    * If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
-    */
-    readonly id?: string;
-    /**
-    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/oci/5.47.0/docs/resources/identity_dynamic_group#matching_rule IdentityDynamicGroup#matching_rule}
-    */
-    readonly matchingRule: string;
-    /**
-    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/oci/5.47.0/docs/resources/identity_dynamic_group#name IdentityDynamicGroup#name}
-    */
-    readonly name: string;
-    /**
-    * timeouts block
-    *
-    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/oci/5.47.0/docs/resources/identity_dynamic_group#timeouts IdentityDynamicGroup#timeouts}
-    */
-    readonly timeouts?: IdentityDynamicGroupTimeouts;
-}
-export interface IdentityDynamicGroupTimeouts {
-    /**
-    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/oci/5.47.0/docs/resources/identity_dynamic_group#create IdentityDynamicGroup#create}
-    */
-    readonly create?: string;
-    /**
-    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/oci/5.47.0/docs/resources/identity_dynamic_group#delete IdentityDynamicGroup#delete}
-    */
-    readonly delete?: string;
-    /**
-    * Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/oci/5.47.0/docs/resources/identity_dynamic_group#update IdentityDynamicGroup#update}
-    */
-    readonly update?: string;
-}
-export declare function identityDynamicGroupTimeoutsToTerraform(struct?: IdentityDynamicGroupTimeouts | cdktf.IResolvable): any;
-export declare function identityDynamicGroupTimeoutsToHclTerraform(struct?: IdentityDynamicGroupTimeouts | cdktf.IResolvable): any;
-export declare class IdentityDynamicGroupTimeoutsOutputReference extends cdktf.ComplexObject {
-    private isEmptyObject;
-    private resolvableValue?;
-    /**
-    * @param terraformResource The parent resource
-    * @param terraformAttribute The attribute on the parent resource this class is referencing
-    */
-    constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
-    get internalValue(): IdentityDynamicGroupTimeouts | cdktf.IResolvable | undefined;
-    set internalValue(value: IdentityDynamicGroupTimeouts | cdktf.IResolvable | undefined);
-    private _create?;
-    get create(): string;
-    set create(value: string);
-    resetCreate(): void;
-    get createInput(): string | undefined;
-    private _delete?;
-    get delete(): string;
-    set delete(value: string);
-    resetDelete(): void;
-    get deleteInput(): string | undefined;
-    private _update?;
-    get update(): string;
-    set update(value: string);
-    resetUpdate(): void;
-    get updateInput(): string | undefined;
-}
-/**
-* Represents a {@link https://registry.terraform.io/providers/hashicorp/oci/5.47.0/docs/resources/identity_dynamic_group oci_identity_dynamic_group}
-*/
-export declare class IdentityDynamicGroup extends cdktf.TerraformResource {
-    static readonly tfResourceType = "oci_identity_dynamic_group";
-    /**
-    * Generates CDKTF code for importing a IdentityDynamicGroup resource upon running "cdktf plan <stack-name>"
-    * @param scope The scope in which to define this construct
-    * @param importToId The construct id used in the generated config for the IdentityDynamicGroup to import
-    * @param importFromId The id of the existing IdentityDynamicGroup that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/oci/5.47.0/docs/resources/identity_dynamic_group#import import section} in the documentation of this resource for the id to use
-    * @param provider? Optional instance of the provider where the IdentityDynamicGroup to import is found
-    */
-    static generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: cdktf.TerraformProvider): cdktf.ImportableResource;
-    /**
-    * Create a new {@link https://registry.terraform.io/providers/hashicorp/oci/5.47.0/docs/resources/identity_dynamic_group oci_identity_dynamic_group} Resource
-    *
-    * @param scope The scope in which to define this construct
-    * @param id The scoped construct ID. Must be unique amongst siblings in the same scope
-    * @param options IdentityDynamicGroupConfig
-    */
-    constructor(scope: Construct, id: string, config: IdentityDynamicGroupConfig);
-    private _compartmentId?;
-    get compartmentId(): string;
-    set compartmentId(value: string);
-    get compartmentIdInput(): string | undefined;
-    private _definedTags?;
-    get definedTags(): {
-        [key: string]: string;
-    };
-    set definedTags(value: {
-        [key: string]: string;
-    });
-    resetDefinedTags(): void;
-    get definedTagsInput(): {
-        [key: string]: string;
-    } | undefined;
-    private _description?;
-    get description(): string;
-    set description(value: string);
-    get descriptionInput(): string | undefined;
-    private _freeformTags?;
-    get freeformTags(): {
-        [key: string]: string;
-    };
-    set freeformTags(value: {
-        [key: string]: string;
-    });
-    resetFreeformTags(): void;
-    get freeformTagsInput(): {
-        [key: string]: string;
-    } | undefined;
-    private _id?;
-    get id(): string;
-    set id(value: string);
-    resetId(): void;
-    get idInput(): string | undefined;
-    get inactiveState(): string;
-    private _matchingRule?;
-    get matchingRule(): string;
-    set matchingRule(value: string);
-    get matchingRuleInput(): string | undefined;
-    private _name?;
-    get name(): string;
-    set name(value: string);
-    get nameInput(): string | undefined;
-    get state(): string;
-    get timeCreated(): string;
-    private _timeouts;
-    get timeouts(): IdentityDynamicGroupTimeoutsOutputReference;
-    putTimeouts(value: IdentityDynamicGroupTimeouts): void;
-    resetTimeouts(): void;
-    get timeoutsInput(): cdktf.IResolvable | IdentityDynamicGroupTimeouts | undefined;
-    protected synthesizeAttributes(): {
-        [name: string]: any;
-    };
-    protected synthesizeHclAttributes(): {
-        [name: string]: any;
-    };
-}