polaris-local-forge/.env.example at main · Snowflake-Labs/polaris-local-forge · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# Polaris Local Forge Environment Configuration
# Copy this file to .env and customize as needed
#
# TIP: For shell usage (kubectl commands), use .envrc with direnv:
#   cp user-project/.envrc.example .envrc && direnv allow

# =============================================================================
# Container Runtime
# =============================================================================

# Container runtime: "podman" or "docker"
# AUTO-DETECTED during 'init' based on what's running:
#   - Docker Desktop running -> docker
#   - Podman machine running -> podman
#   - Neither running -> uses whichever is installed
# Uncomment and set manually only to override auto-detection.
# PLF_CONTAINER_RUNTIME=

# Podman machine name (macOS only). A dedicated machine is created for k3d.
# All Podman/k3d operations are pinned to this machine's socket.
PLF_PODMAN_MACHINE=k3d

# =============================================================================
# Cluster Configuration
# =============================================================================

# Cluster name (defaults to project directory name if not set)
# K3D_CLUSTER_NAME=my-cluster

# K3S version (default: v1.31.5-k3s1)
# Run `polaris-local-forge cluster bump-k3s --dry-run` to see latest available
K3S_VERSION=v1.35.1-k3s1

# Kubeconfig path (relative paths are resolved against --work-dir by the CLI)
# For direct shell use (kubectl), use .envrc which exports an absolute path
KUBECONFIG=.kube/config

# =============================================================================
# RustFS S3-Compatible Storage Configuration
# =============================================================================

# S3 endpoint URL (API)
AWS_ENDPOINT_URL=http://localhost:19000

# RustFS Admin Console URL
RUSTFS_CONSOLE_URL=http://localhost:19001

# S3 credentials (default RustFS credentials)
AWS_ACCESS_KEY_ID=admin
AWS_SECRET_ACCESS_KEY=password

# AWS region
AWS_REGION=us-east-1

# Project-local AWS config files (generated by 'prepare')
# These let aws CLI use RustFS without modifying ~/.aws/
AWS_CONFIG_FILE=.aws/config
AWS_SHARED_CREDENTIALS_FILE=.aws/credentials

# =============================================================================
# Polaris Configuration
# =============================================================================

# Polaris API endpoint (for catalog operations)
POLARIS_URL=http://localhost:18181

# Polaris realm (default: POLARIS)
POLARIS_REALM=POLARIS

# =============================================================================
# Catalog Configuration
# =============================================================================

# S3 bucket name for demo catalog
PLF_POLARIS_S3_BUCKET=polaris

# Catalog name
PLF_POLARIS_CATALOG_NAME=polardb

# Principal name
PLF_POLARIS_PRINCIPAL_NAME=super_user

# =============================================================================
# Snowflake Connection (shared across skills)
# =============================================================================
# Auto-populated by `plf l2c setup aws` if not already set.
# Can also be set manually or by snow-utils-skills.

# SNOWFLAKE_DEFAULT_CONNECTION_NAME=
# SNOWFLAKE_ACCOUNT=
# SNOWFLAKE_USER=
# SNOWFLAKE_ACCOUNT_URL=

# =============================================================================
# L2C Migration (Local to Cloud)
# =============================================================================
# Settings for `plf l2c` commands that migrate local Polaris experiments
# to AWS S3 + Snowflake External Iceberg Tables.

# Prefix for AWS resource names (default: SNOWFLAKE_USER, lowercase)
# Avoids naming conflicts in shared AWS accounts. Use --no-prefix to disable.
# L2C_PREFIX=

# AWS profile for cloud operations (from ~/.aws/config, NOT the RustFS creds above)
# L2C_AWS_PROFILE=my-aws-sso-profile

# AWS region for cloud S3 bucket and IAM resources
# L2C_AWS_REGION=us-east-1

# Snowflake target database and schema
# L2C_SF_DATABASE=MY_ICEBERG_DB
# L2C_SF_SCHEMA=PUBLIC

# Service account role for restricted DDL on target DB/schema
# SA_ROLE=PLF_MIGRATION_ROLE

# Catalog integration name (CATALOG_SOURCE=OBJECT_STORE, TABLE_FORMAT=ICEBERG)
# L2C_CATALOG_INTEGRATION=PLF_L2C_CATALOG_INT