Update preview docs
This commit is contained in:
2
Makefile
2
Makefile
@@ -243,6 +243,6 @@ sdk/java: $(PULUMI) bin/${PROVIDER}
|
||||
cd ${TMPDIR}/java/ && gradle --console=plain build
|
||||
mv -f ${TMPDIR}/java ${WORKING_DIR}/sdk/.
|
||||
|
||||
docs: $(shell find docs/yaml -type f) $(shell find ./provider/internal/embed -name '*.md')
|
||||
docs: $(shell find docs/yaml -type f) $(shell find ./provider/internal/embed -name '*.md') ${SCHEMA_PATH}
|
||||
go generate docs/generate.go
|
||||
@touch docs
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -1,6 +1,6 @@
|
||||
## Migrating v3 and v4 Image resources
|
||||
## Migrating Pulumi Docker v3 and v4 Image resources
|
||||
|
||||
The `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
|
||||
This provider's `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
|
||||
Existing `Image` resources can be converted to the docker-build `Image` resources with minor modifications.
|
||||
|
||||
### Behavioral differences
|
||||
@@ -14,19 +14,17 @@ This is helpful as a safeguard to prevent "broken" images from merging, but user
|
||||
|
||||
Version `4.x` changed build-on-preview behavior to be opt-in.
|
||||
By default, `v4.x` `Image` resources do _not_ build during previews, but this behavior can be toggled with the `buildOnPreview` option.
|
||||
Some users felt this made previews in CI less helpful because they no longer detected bad images by default.
|
||||
Several users reported outages due to the default behavior allowing bad images to accidentally sneak through CI.
|
||||
|
||||
The default behavior of the `Image` resource has been changed to strike a better balance between CI use cases and manual updates.
|
||||
By default, Pulumi will now only build `Image` resources during previews when it detects a CI environment like GitHub Actions.
|
||||
Previews run in non-CI environments will not build images.
|
||||
This behavior is still configurable with `buildOnPreview`.
|
||||
The default behavior of this provider's `Image` resource is similar to `3.x` and will build images during previews.
|
||||
This behavior can be changed by specifying `buildOnPreview`.
|
||||
|
||||
#### Push behavior
|
||||
|
||||
Versions `3.x` and `4.x` of the Pulumi Docker provider attempt to push images to remote registries by default.
|
||||
They expose a `skipPush: true` option to disable pushing.
|
||||
|
||||
The `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
|
||||
This provider's `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
|
||||
|
||||
To push images to a registry you can include `push: true` (equivalent to Docker's `--push` flag) or configure an `export` of type `registry` (equivalent to Docker's `--output type=registry`).
|
||||
Like Docker, if an image is configured without exports you will see a warning with instructions for how to enable pushing, but the build will still proceed normally.
|
||||
|
||||
14
sdk/dotnet/Image.cs
generated
14
sdk/dotnet/Image.cs
generated
@@ -20,9 +20,9 @@ namespace Pulumi.DockerBuild
|
||||
/// We will strive to keep APIs and behavior as stable as possible, but we
|
||||
/// cannot guarantee stability until version 1.0.
|
||||
///
|
||||
/// ## Migrating v3 and v4 Image resources
|
||||
/// ## Migrating Pulumi Docker v3 and v4 Image resources
|
||||
///
|
||||
/// The `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
|
||||
/// This provider's `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
|
||||
/// Existing `Image` resources can be converted to the docker-build `Image` resources with minor modifications.
|
||||
///
|
||||
/// ### Behavioral differences
|
||||
@@ -36,19 +36,17 @@ namespace Pulumi.DockerBuild
|
||||
///
|
||||
/// Version `4.x` changed build-on-preview behavior to be opt-in.
|
||||
/// By default, `v4.x` `Image` resources do _not_ build during previews, but this behavior can be toggled with the `buildOnPreview` option.
|
||||
/// Some users felt this made previews in CI less helpful because they no longer detected bad images by default.
|
||||
/// Several users reported outages due to the default behavior allowing bad images to accidentally sneak through CI.
|
||||
///
|
||||
/// The default behavior of the `Image` resource has been changed to strike a better balance between CI use cases and manual updates.
|
||||
/// By default, Pulumi will now only build `Image` resources during previews when it detects a CI environment like GitHub Actions.
|
||||
/// Previews run in non-CI environments will not build images.
|
||||
/// This behavior is still configurable with `buildOnPreview`.
|
||||
/// The default behavior of this provider's `Image` resource is similar to `3.x` and will build images during previews.
|
||||
/// This behavior can be changed by specifying `buildOnPreview`.
|
||||
///
|
||||
/// #### Push behavior
|
||||
///
|
||||
/// Versions `3.x` and `4.x` of the Pulumi Docker provider attempt to push images to remote registries by default.
|
||||
/// They expose a `skipPush: true` option to disable pushing.
|
||||
///
|
||||
/// The `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
|
||||
/// This provider's `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
|
||||
///
|
||||
/// To push images to a registry you can include `push: true` (equivalent to Docker's `--push` flag) or configure an `export` of type `registry` (equivalent to Docker's `--output type=registry`).
|
||||
/// Like Docker, if an image is configured without exports you will see a warning with instructions for how to enable pushing, but the build will still proceed normally.
|
||||
|
||||
14
sdk/go/dockerbuild/image.go
generated
14
sdk/go/dockerbuild/image.go
generated
@@ -22,9 +22,9 @@ import (
|
||||
// We will strive to keep APIs and behavior as stable as possible, but we
|
||||
// cannot guarantee stability until version 1.0.
|
||||
//
|
||||
// ## Migrating v3 and v4 Image resources
|
||||
// ## Migrating Pulumi Docker v3 and v4 Image resources
|
||||
//
|
||||
// The `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
|
||||
// This provider's `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
|
||||
// Existing `Image` resources can be converted to the docker-build `Image` resources with minor modifications.
|
||||
//
|
||||
// ### Behavioral differences
|
||||
@@ -38,19 +38,17 @@ import (
|
||||
//
|
||||
// Version `4.x` changed build-on-preview behavior to be opt-in.
|
||||
// By default, `v4.x` `Image` resources do _not_ build during previews, but this behavior can be toggled with the `buildOnPreview` option.
|
||||
// Some users felt this made previews in CI less helpful because they no longer detected bad images by default.
|
||||
// Several users reported outages due to the default behavior allowing bad images to accidentally sneak through CI.
|
||||
//
|
||||
// The default behavior of the `Image` resource has been changed to strike a better balance between CI use cases and manual updates.
|
||||
// By default, Pulumi will now only build `Image` resources during previews when it detects a CI environment like GitHub Actions.
|
||||
// Previews run in non-CI environments will not build images.
|
||||
// This behavior is still configurable with `buildOnPreview`.
|
||||
// The default behavior of this provider's `Image` resource is similar to `3.x` and will build images during previews.
|
||||
// This behavior can be changed by specifying `buildOnPreview`.
|
||||
//
|
||||
// #### Push behavior
|
||||
//
|
||||
// Versions `3.x` and `4.x` of the Pulumi Docker provider attempt to push images to remote registries by default.
|
||||
// They expose a `skipPush: true` option to disable pushing.
|
||||
//
|
||||
// The `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
|
||||
// This provider's `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
|
||||
//
|
||||
// To push images to a registry you can include `push: true` (equivalent to Docker's `--push` flag) or configure an `export` of type `registry` (equivalent to Docker's `--output type=registry`).
|
||||
// Like Docker, if an image is configured without exports you will see a warning with instructions for how to enable pushing, but the build will still proceed normally.
|
||||
|
||||
14
sdk/go/dockerbuild/x/image.go
generated
14
sdk/go/dockerbuild/x/image.go
generated
@@ -22,9 +22,9 @@ import (
|
||||
// We will strive to keep APIs and behavior as stable as possible, but we
|
||||
// cannot guarantee stability until version 1.0.
|
||||
//
|
||||
// ## Migrating v3 and v4 Image resources
|
||||
// ## Migrating Pulumi Docker v3 and v4 Image resources
|
||||
//
|
||||
// The `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
|
||||
// This provider's `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
|
||||
// Existing `Image` resources can be converted to the docker-build `Image` resources with minor modifications.
|
||||
//
|
||||
// ### Behavioral differences
|
||||
@@ -38,19 +38,17 @@ import (
|
||||
//
|
||||
// Version `4.x` changed build-on-preview behavior to be opt-in.
|
||||
// By default, `v4.x` `Image` resources do _not_ build during previews, but this behavior can be toggled with the `buildOnPreview` option.
|
||||
// Some users felt this made previews in CI less helpful because they no longer detected bad images by default.
|
||||
// Several users reported outages due to the default behavior allowing bad images to accidentally sneak through CI.
|
||||
//
|
||||
// The default behavior of the `Image` resource has been changed to strike a better balance between CI use cases and manual updates.
|
||||
// By default, Pulumi will now only build `Image` resources during previews when it detects a CI environment like GitHub Actions.
|
||||
// Previews run in non-CI environments will not build images.
|
||||
// This behavior is still configurable with `buildOnPreview`.
|
||||
// The default behavior of this provider's `Image` resource is similar to `3.x` and will build images during previews.
|
||||
// This behavior can be changed by specifying `buildOnPreview`.
|
||||
//
|
||||
// #### Push behavior
|
||||
//
|
||||
// Versions `3.x` and `4.x` of the Pulumi Docker provider attempt to push images to remote registries by default.
|
||||
// They expose a `skipPush: true` option to disable pushing.
|
||||
//
|
||||
// The `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
|
||||
// This provider's `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
|
||||
//
|
||||
// To push images to a registry you can include `push: true` (equivalent to Docker's `--push` flag) or configure an `export` of type `registry` (equivalent to Docker's `--output type=registry`).
|
||||
// Like Docker, if an image is configured without exports you will see a warning with instructions for how to enable pushing, but the build will still proceed normally.
|
||||
|
||||
@@ -36,9 +36,9 @@ import javax.annotation.Nullable;
|
||||
* We will strive to keep APIs and behavior as stable as possible, but we
|
||||
* cannot guarantee stability until version 1.0.
|
||||
*
|
||||
* ## Migrating v3 and v4 Image resources
|
||||
* ## Migrating Pulumi Docker v3 and v4 Image resources
|
||||
*
|
||||
* The `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
|
||||
* This provider's `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
|
||||
* Existing `Image` resources can be converted to the docker-build `Image` resources with minor modifications.
|
||||
*
|
||||
* ### Behavioral differences
|
||||
@@ -52,19 +52,17 @@ import javax.annotation.Nullable;
|
||||
*
|
||||
* Version `4.x` changed build-on-preview behavior to be opt-in.
|
||||
* By default, `v4.x` `Image` resources do _not_ build during previews, but this behavior can be toggled with the `buildOnPreview` option.
|
||||
* Some users felt this made previews in CI less helpful because they no longer detected bad images by default.
|
||||
* Several users reported outages due to the default behavior allowing bad images to accidentally sneak through CI.
|
||||
*
|
||||
* The default behavior of the `Image` resource has been changed to strike a better balance between CI use cases and manual updates.
|
||||
* By default, Pulumi will now only build `Image` resources during previews when it detects a CI environment like GitHub Actions.
|
||||
* Previews run in non-CI environments will not build images.
|
||||
* This behavior is still configurable with `buildOnPreview`.
|
||||
* The default behavior of this provider's `Image` resource is similar to `3.x` and will build images during previews.
|
||||
* This behavior can be changed by specifying `buildOnPreview`.
|
||||
*
|
||||
* #### Push behavior
|
||||
*
|
||||
* Versions `3.x` and `4.x` of the Pulumi Docker provider attempt to push images to remote registries by default.
|
||||
* They expose a `skipPush: true` option to disable pushing.
|
||||
*
|
||||
* The `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
|
||||
* This provider's `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
|
||||
*
|
||||
* To push images to a registry you can include `push: true` (equivalent to Docker's `--push` flag) or configure an `export` of type `registry` (equivalent to Docker's `--output type=registry`).
|
||||
* Like Docker, if an image is configured without exports you will see a warning with instructions for how to enable pushing, but the build will still proceed normally.
|
||||
|
||||
14
sdk/nodejs/image.ts
generated
14
sdk/nodejs/image.ts
generated
@@ -18,9 +18,9 @@ import * as utilities from "./utilities";
|
||||
* We will strive to keep APIs and behavior as stable as possible, but we
|
||||
* cannot guarantee stability until version 1.0.
|
||||
*
|
||||
* ## Migrating v3 and v4 Image resources
|
||||
* ## Migrating Pulumi Docker v3 and v4 Image resources
|
||||
*
|
||||
* The `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
|
||||
* This provider's `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
|
||||
* Existing `Image` resources can be converted to the docker-build `Image` resources with minor modifications.
|
||||
*
|
||||
* ### Behavioral differences
|
||||
@@ -34,19 +34,17 @@ import * as utilities from "./utilities";
|
||||
*
|
||||
* Version `4.x` changed build-on-preview behavior to be opt-in.
|
||||
* By default, `v4.x` `Image` resources do _not_ build during previews, but this behavior can be toggled with the `buildOnPreview` option.
|
||||
* Some users felt this made previews in CI less helpful because they no longer detected bad images by default.
|
||||
* Several users reported outages due to the default behavior allowing bad images to accidentally sneak through CI.
|
||||
*
|
||||
* The default behavior of the `Image` resource has been changed to strike a better balance between CI use cases and manual updates.
|
||||
* By default, Pulumi will now only build `Image` resources during previews when it detects a CI environment like GitHub Actions.
|
||||
* Previews run in non-CI environments will not build images.
|
||||
* This behavior is still configurable with `buildOnPreview`.
|
||||
* The default behavior of this provider's `Image` resource is similar to `3.x` and will build images during previews.
|
||||
* This behavior can be changed by specifying `buildOnPreview`.
|
||||
*
|
||||
* #### Push behavior
|
||||
*
|
||||
* Versions `3.x` and `4.x` of the Pulumi Docker provider attempt to push images to remote registries by default.
|
||||
* They expose a `skipPush: true` option to disable pushing.
|
||||
*
|
||||
* The `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
|
||||
* This provider's `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
|
||||
*
|
||||
* To push images to a registry you can include `push: true` (equivalent to Docker's `--push` flag) or configure an `export` of type `registry` (equivalent to Docker's `--output type=registry`).
|
||||
* Like Docker, if an image is configured without exports you will see a warning with instructions for how to enable pushing, but the build will still proceed normally.
|
||||
|
||||
28
sdk/python/pulumi_docker_build/image.py
generated
28
sdk/python/pulumi_docker_build/image.py
generated
@@ -617,9 +617,9 @@ class Image(pulumi.CustomResource):
|
||||
We will strive to keep APIs and behavior as stable as possible, but we
|
||||
cannot guarantee stability until version 1.0.
|
||||
|
||||
## Migrating v3 and v4 Image resources
|
||||
## Migrating Pulumi Docker v3 and v4 Image resources
|
||||
|
||||
The `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
|
||||
This provider's `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
|
||||
Existing `Image` resources can be converted to the docker-build `Image` resources with minor modifications.
|
||||
|
||||
### Behavioral differences
|
||||
@@ -633,19 +633,17 @@ class Image(pulumi.CustomResource):
|
||||
|
||||
Version `4.x` changed build-on-preview behavior to be opt-in.
|
||||
By default, `v4.x` `Image` resources do _not_ build during previews, but this behavior can be toggled with the `buildOnPreview` option.
|
||||
Some users felt this made previews in CI less helpful because they no longer detected bad images by default.
|
||||
Several users reported outages due to the default behavior allowing bad images to accidentally sneak through CI.
|
||||
|
||||
The default behavior of the `Image` resource has been changed to strike a better balance between CI use cases and manual updates.
|
||||
By default, Pulumi will now only build `Image` resources during previews when it detects a CI environment like GitHub Actions.
|
||||
Previews run in non-CI environments will not build images.
|
||||
This behavior is still configurable with `buildOnPreview`.
|
||||
The default behavior of this provider's `Image` resource is similar to `3.x` and will build images during previews.
|
||||
This behavior can be changed by specifying `buildOnPreview`.
|
||||
|
||||
#### Push behavior
|
||||
|
||||
Versions `3.x` and `4.x` of the Pulumi Docker provider attempt to push images to remote registries by default.
|
||||
They expose a `skipPush: true` option to disable pushing.
|
||||
|
||||
The `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
|
||||
This provider's `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
|
||||
|
||||
To push images to a registry you can include `push: true` (equivalent to Docker's `--push` flag) or configure an `export` of type `registry` (equivalent to Docker's `--output type=registry`).
|
||||
Like Docker, if an image is configured without exports you will see a warning with instructions for how to enable pushing, but the build will still proceed normally.
|
||||
@@ -1045,9 +1043,9 @@ class Image(pulumi.CustomResource):
|
||||
We will strive to keep APIs and behavior as stable as possible, but we
|
||||
cannot guarantee stability until version 1.0.
|
||||
|
||||
## Migrating v3 and v4 Image resources
|
||||
## Migrating Pulumi Docker v3 and v4 Image resources
|
||||
|
||||
The `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
|
||||
This provider's `Image` resource provides a superset of functionality over the `Image` resources available in versions 3 and 4 of the Pulumi Docker provider.
|
||||
Existing `Image` resources can be converted to the docker-build `Image` resources with minor modifications.
|
||||
|
||||
### Behavioral differences
|
||||
@@ -1061,19 +1059,17 @@ class Image(pulumi.CustomResource):
|
||||
|
||||
Version `4.x` changed build-on-preview behavior to be opt-in.
|
||||
By default, `v4.x` `Image` resources do _not_ build during previews, but this behavior can be toggled with the `buildOnPreview` option.
|
||||
Some users felt this made previews in CI less helpful because they no longer detected bad images by default.
|
||||
Several users reported outages due to the default behavior allowing bad images to accidentally sneak through CI.
|
||||
|
||||
The default behavior of the `Image` resource has been changed to strike a better balance between CI use cases and manual updates.
|
||||
By default, Pulumi will now only build `Image` resources during previews when it detects a CI environment like GitHub Actions.
|
||||
Previews run in non-CI environments will not build images.
|
||||
This behavior is still configurable with `buildOnPreview`.
|
||||
The default behavior of this provider's `Image` resource is similar to `3.x` and will build images during previews.
|
||||
This behavior can be changed by specifying `buildOnPreview`.
|
||||
|
||||
#### Push behavior
|
||||
|
||||
Versions `3.x` and `4.x` of the Pulumi Docker provider attempt to push images to remote registries by default.
|
||||
They expose a `skipPush: true` option to disable pushing.
|
||||
|
||||
The `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
|
||||
This provider's `Image` resource matches the Docker CLI's behavior and does not push images anywhere by default.
|
||||
|
||||
To push images to a registry you can include `push: true` (equivalent to Docker's `--push` flag) or configure an `export` of type `registry` (equivalent to Docker's `--output type=registry`).
|
||||
Like Docker, if an image is configured without exports you will see a warning with instructions for how to enable pushing, but the build will still proceed normally.
|
||||
|
||||
Reference in New Issue
Block a user