liveBook · Manning

Environment interface

As explained in Platform Engineering on Kubernetes

An environment interface is a book-specific API contract representing a request to provision and configure a development environment.

An environment interface is a platform API contract for requesting development environments. Teams create environment resources with a type and configurable options, while the platform hides provisioning complexity behind the abstraction. section 6.1.1

A request can define:

  • The environment name and requested type, such as development. section 6.1.1
  • Team-specific parameters, such as whether infrastructure components or application services should be installed. section 6.1.1
  • Only user-facing configuration; implementation details remain inside the platform and can evolve behind the interface. section 6.1.1

Environment request

A request named my-dev-env can select the development type, install infrastructure, and enable frontend debugging through parameters.

Figure 6.2 Application development team interactions with the platform . #1 App dev teams can request as many Development Environments as they need to the platform APIs; #2 The platform has encoded how to provision all the components and tools needed for the app dev team to work; #3 The platform needs to give access to the app dev team to use the newly provisioned environment.

Shows the workflow from team requests through platform provisioning to access to the resulting development environment. section 6.1.1

How Platform Engineering on Kubernetes covers it

How deep it goes
Defines the contract, parameters, and abstraction boundary but stops short of provisioning implementation details.
Examples
Uses a JSON request with a name, development type, infrastructure flag, and frontend debugging option.
What you can do after
Configure development-environment requests without depending on how the platform provisions their underlying components.
How it connects
Connects platform APIs, development environments, environment resources, and configurable application services.

Related concepts

This explainer was generated by Manning's knowledge graph from the text of Platform Engineering on Kubernetes. The section links point to the parts of the book it draws on.