1. Docs
  2. Secrets & Configuration
  3. Guides
  4. Importing Environments

Importing Environments

    This guide provides a step-by-step tutorial for getting started with environment imports. For complete technical reference including JSON Merge Patch semantics, implicit imports, and advanced composition patterns, see Importing environments.

    Overview

    There may be scenarios where the value you need to retrieve is stored in a different environment file. For example, imagine you are building a system that integrates with a third-party service such as:

    • a payment provider
    • weather data provider
    • a content-management system

    In the development environment, you might be integrating with the sandbox or development endpoint of the third-party service, while in the testing environment, you might be integrating with the production endpoint. Both endpoints may share the same base URL.

    Image showing same base URL and different endpoints

    Since this base URL would be the same across environments, it would be more efficient to define it once in one place rather than multiple times across multiple environment files.

    With Pulumi ESC, you can import other environments into your environment file and make use of the imported configuration values and secrets. Similar to values, imports is a top-level key you will need to define in the environment file, meaning the syntax to create an import looks like the following:

    imports:
      - project-name/environment-name-1
      - project-name/environment-name-2
    values:
        ...
        ...
    

    Prerequisites

    Before you begin, you should have:

    1. Created at least one environment in Pulumi ESC
    2. Basic familiarity with defining values in environments

    What you’ll learn

    In this guide, you will:

    1. Create a shared environment with common configuration
    2. Import that environment into another environment
    3. Verify that imported values are accessible

    Import an environment

    To demonstrate how this works, you will need to create a second environment. For the purposes of this guide, we will name this new environment my-project/app-global-config. In this environment, replace the placeholder content with the following configuration:

    values:
      ENDPOINT_URL: "https://wordsapiv1.p.rapidapi.com/"
    

    Then, open your first environment (e.g. my-project/dev-environment) via Pulumi Cloud or the ESC CLI and add the following configuration to the top of your file:

    imports:
      - my-project/app-global-config
    

    Your updated environment file should look similar to the following:

    # Example contents of my-project/dev-environment
    imports:
      - my-project/app-global-config
    values:
      myEnvironment: "development"
      myPassword:
        fn::secret:
          ciphertext: ZXNjeAA....
    

    After saving your changes, you should now see "ENDPOINT_URL": "https://wordsapiv1.p.rapidapi.com/" in the environment preview pane. This confirms that the value was successfully imported from the my-project/app-global-config environment.

    Success! You’ve now imported an environment. The imported ENDPOINT_URL value is accessible in the same way as values defined directly in this environment. You can retrieve it via the console or CLI just like any other value.

    To test this, try retrieving the imported value via the console or CLI. See Managing secrets for details on retrieving values.
    You can import multiple environments and reorder them. Import order matters when the same keys appear in multiple imported environments. For details on merge behavior and override semantics, see the imports reference.

    Next steps