pulumi-gcp-kotlin/com.pulumi.gcp.gkebackup.kotlin/RestorePlan

RestorePlan

class RestorePlan : KotlinCustomResource

Represents a Restore Plan instance. To get more information about RestorePlan, see:

Example Usage

Gkebackup Restoreplan All Namespaces

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.container.Cluster;
import com.pulumi.gcp.container.ClusterArgs;
import com.pulumi.gcp.container.inputs.ClusterWorkloadIdentityConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigGkeBackupAgentConfigArgs;
import com.pulumi.gcp.gkebackup.BackupPlan;
import com.pulumi.gcp.gkebackup.BackupPlanArgs;
import com.pulumi.gcp.gkebackup.inputs.BackupPlanBackupConfigArgs;
import com.pulumi.gcp.gkebackup.RestorePlan;
import com.pulumi.gcp.gkebackup.RestorePlanArgs;
import com.pulumi.gcp.gkebackup.inputs.RestorePlanRestoreConfigArgs;
import com.pulumi.gcp.gkebackup.inputs.RestorePlanRestoreConfigClusterResourceRestoreScopeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var primary = new Cluster("primary", ClusterArgs.builder()
            .location("us-central1")
            .initialNodeCount(1)
            .workloadIdentityConfig(ClusterWorkloadIdentityConfigArgs.builder()
                .workloadPool("my-project-name.svc.id.goog")
                .build())
            .addonsConfig(ClusterAddonsConfigArgs.builder()
                .gkeBackupAgentConfig(ClusterAddonsConfigGkeBackupAgentConfigArgs.builder()
                    .enabled(true)
                    .build())
                .build())
            .build());
        var basic = new BackupPlan("basic", BackupPlanArgs.builder()
            .cluster(primary.id())
            .location("us-central1")
            .backupConfig(BackupPlanBackupConfigArgs.builder()
                .includeVolumeData(true)
                .includeSecrets(true)
                .allNamespaces(true)
                .build())
            .build());
        var allNs = new RestorePlan("allNs", RestorePlanArgs.builder()
            .location("us-central1")
            .backupPlan(basic.id())
            .cluster(primary.id())
            .restoreConfig(RestorePlanRestoreConfigArgs.builder()
                .allNamespaces(true)
                .namespacedResourceRestoreMode("FAIL_ON_CONFLICT")
                .volumeDataRestorePolicy("RESTORE_VOLUME_DATA_FROM_BACKUP")
                .clusterResourceRestoreScope(RestorePlanRestoreConfigClusterResourceRestoreScopeArgs.builder()
                    .allGroupKinds(true)
                    .build())
                .clusterResourceConflictPolicy("USE_EXISTING_VERSION")
                .build())
            .build());
    }
}
Content copied to clipboard

Gkebackup Restoreplan Rollback Namespace

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.container.Cluster;
import com.pulumi.gcp.container.ClusterArgs;
import com.pulumi.gcp.container.inputs.ClusterWorkloadIdentityConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigGkeBackupAgentConfigArgs;
import com.pulumi.gcp.gkebackup.BackupPlan;
import com.pulumi.gcp.gkebackup.BackupPlanArgs;
import com.pulumi.gcp.gkebackup.inputs.BackupPlanBackupConfigArgs;
import com.pulumi.gcp.gkebackup.RestorePlan;
import com.pulumi.gcp.gkebackup.RestorePlanArgs;
import com.pulumi.gcp.gkebackup.inputs.RestorePlanRestoreConfigArgs;
import com.pulumi.gcp.gkebackup.inputs.RestorePlanRestoreConfigSelectedNamespacesArgs;
import com.pulumi.gcp.gkebackup.inputs.RestorePlanRestoreConfigClusterResourceRestoreScopeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var primary = new Cluster("primary", ClusterArgs.builder()
            .location("us-central1")
            .initialNodeCount(1)
            .workloadIdentityConfig(ClusterWorkloadIdentityConfigArgs.builder()
                .workloadPool("my-project-name.svc.id.goog")
                .build())
            .addonsConfig(ClusterAddonsConfigArgs.builder()
                .gkeBackupAgentConfig(ClusterAddonsConfigGkeBackupAgentConfigArgs.builder()
                    .enabled(true)
                    .build())
                .build())
            .build());
        var basic = new BackupPlan("basic", BackupPlanArgs.builder()
            .cluster(primary.id())
            .location("us-central1")
            .backupConfig(BackupPlanBackupConfigArgs.builder()
                .includeVolumeData(true)
                .includeSecrets(true)
                .allNamespaces(true)
                .build())
            .build());
        var rollbackNs = new RestorePlan("rollbackNs", RestorePlanArgs.builder()
            .location("us-central1")
            .backupPlan(basic.id())
            .cluster(primary.id())
            .restoreConfig(RestorePlanRestoreConfigArgs.builder()
                .selectedNamespaces(RestorePlanRestoreConfigSelectedNamespacesArgs.builder()
                    .namespaces("my-ns")
                    .build())
                .namespacedResourceRestoreMode("DELETE_AND_RESTORE")
                .volumeDataRestorePolicy("RESTORE_VOLUME_DATA_FROM_BACKUP")
                .clusterResourceRestoreScope(RestorePlanRestoreConfigClusterResourceRestoreScopeArgs.builder()
                    .selectedGroupKinds(
                        RestorePlanRestoreConfigClusterResourceRestoreScopeSelectedGroupKindArgs.builder()
                            .resourceGroup("apiextension.k8s.io")
                            .resourceKind("CustomResourceDefinition")
                            .build(),
                        RestorePlanRestoreConfigClusterResourceRestoreScopeSelectedGroupKindArgs.builder()
                            .resourceGroup("storage.k8s.io")
                            .resourceKind("StorageClass")
                            .build())
                    .build())
                .clusterResourceConflictPolicy("USE_EXISTING_VERSION")
                .build())
            .build());
    }
}
Content copied to clipboard

Gkebackup Restoreplan Protected Application

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.container.Cluster;
import com.pulumi.gcp.container.ClusterArgs;
import com.pulumi.gcp.container.inputs.ClusterWorkloadIdentityConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigGkeBackupAgentConfigArgs;
import com.pulumi.gcp.gkebackup.BackupPlan;
import com.pulumi.gcp.gkebackup.BackupPlanArgs;
import com.pulumi.gcp.gkebackup.inputs.BackupPlanBackupConfigArgs;
import com.pulumi.gcp.gkebackup.RestorePlan;
import com.pulumi.gcp.gkebackup.RestorePlanArgs;
import com.pulumi.gcp.gkebackup.inputs.RestorePlanRestoreConfigArgs;
import com.pulumi.gcp.gkebackup.inputs.RestorePlanRestoreConfigSelectedApplicationsArgs;
import com.pulumi.gcp.gkebackup.inputs.RestorePlanRestoreConfigClusterResourceRestoreScopeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var primary = new Cluster("primary", ClusterArgs.builder()
            .location("us-central1")
            .initialNodeCount(1)
            .workloadIdentityConfig(ClusterWorkloadIdentityConfigArgs.builder()
                .workloadPool("my-project-name.svc.id.goog")
                .build())
            .addonsConfig(ClusterAddonsConfigArgs.builder()
                .gkeBackupAgentConfig(ClusterAddonsConfigGkeBackupAgentConfigArgs.builder()
                    .enabled(true)
                    .build())
                .build())
            .build());
        var basic = new BackupPlan("basic", BackupPlanArgs.builder()
            .cluster(primary.id())
            .location("us-central1")
            .backupConfig(BackupPlanBackupConfigArgs.builder()
                .includeVolumeData(true)
                .includeSecrets(true)
                .allNamespaces(true)
                .build())
            .build());
        var rollbackApp = new RestorePlan("rollbackApp", RestorePlanArgs.builder()
            .location("us-central1")
            .backupPlan(basic.id())
            .cluster(primary.id())
            .restoreConfig(RestorePlanRestoreConfigArgs.builder()
                .selectedApplications(RestorePlanRestoreConfigSelectedApplicationsArgs.builder()
                    .namespacedNames(RestorePlanRestoreConfigSelectedApplicationsNamespacedNameArgs.builder()
                        .name("my-app")
                        .namespace("my-ns")
                        .build())
                    .build())
                .namespacedResourceRestoreMode("DELETE_AND_RESTORE")
                .volumeDataRestorePolicy("REUSE_VOLUME_HANDLE_FROM_BACKUP")
                .clusterResourceRestoreScope(RestorePlanRestoreConfigClusterResourceRestoreScopeArgs.builder()
                    .noGroupKinds(true)
                    .build())
                .build())
            .build());
    }
}
Content copied to clipboard

Gkebackup Restoreplan All Cluster Resources

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.container.Cluster;
import com.pulumi.gcp.container.ClusterArgs;
import com.pulumi.gcp.container.inputs.ClusterWorkloadIdentityConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigGkeBackupAgentConfigArgs;
import com.pulumi.gcp.gkebackup.BackupPlan;
import com.pulumi.gcp.gkebackup.BackupPlanArgs;
import com.pulumi.gcp.gkebackup.inputs.BackupPlanBackupConfigArgs;
import com.pulumi.gcp.gkebackup.RestorePlan;
import com.pulumi.gcp.gkebackup.RestorePlanArgs;
import com.pulumi.gcp.gkebackup.inputs.RestorePlanRestoreConfigArgs;
import com.pulumi.gcp.gkebackup.inputs.RestorePlanRestoreConfigClusterResourceRestoreScopeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var primary = new Cluster("primary", ClusterArgs.builder()
            .location("us-central1")
            .initialNodeCount(1)
            .workloadIdentityConfig(ClusterWorkloadIdentityConfigArgs.builder()
                .workloadPool("my-project-name.svc.id.goog")
                .build())
            .addonsConfig(ClusterAddonsConfigArgs.builder()
                .gkeBackupAgentConfig(ClusterAddonsConfigGkeBackupAgentConfigArgs.builder()
                    .enabled(true)
                    .build())
                .build())
            .build());
        var basic = new BackupPlan("basic", BackupPlanArgs.builder()
            .cluster(primary.id())
            .location("us-central1")
            .backupConfig(BackupPlanBackupConfigArgs.builder()
                .includeVolumeData(true)
                .includeSecrets(true)
                .allNamespaces(true)
                .build())
            .build());
        var allClusterResources = new RestorePlan("allClusterResources", RestorePlanArgs.builder()
            .location("us-central1")
            .backupPlan(basic.id())
            .cluster(primary.id())
            .restoreConfig(RestorePlanRestoreConfigArgs.builder()
                .noNamespaces(true)
                .namespacedResourceRestoreMode("FAIL_ON_CONFLICT")
                .clusterResourceRestoreScope(RestorePlanRestoreConfigClusterResourceRestoreScopeArgs.builder()
                    .allGroupKinds(true)
                    .build())
                .clusterResourceConflictPolicy("USE_EXISTING_VERSION")
                .build())
            .build());
    }
}
Content copied to clipboard

Gkebackup Restoreplan Rename Namespace

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.container.Cluster;
import com.pulumi.gcp.container.ClusterArgs;
import com.pulumi.gcp.container.inputs.ClusterWorkloadIdentityConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigGkeBackupAgentConfigArgs;
import com.pulumi.gcp.gkebackup.BackupPlan;
import com.pulumi.gcp.gkebackup.BackupPlanArgs;
import com.pulumi.gcp.gkebackup.inputs.BackupPlanBackupConfigArgs;
import com.pulumi.gcp.gkebackup.RestorePlan;
import com.pulumi.gcp.gkebackup.RestorePlanArgs;
import com.pulumi.gcp.gkebackup.inputs.RestorePlanRestoreConfigArgs;
import com.pulumi.gcp.gkebackup.inputs.RestorePlanRestoreConfigSelectedNamespacesArgs;
import com.pulumi.gcp.gkebackup.inputs.RestorePlanRestoreConfigClusterResourceRestoreScopeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var primary = new Cluster("primary", ClusterArgs.builder()
            .location("us-central1")
            .initialNodeCount(1)
            .workloadIdentityConfig(ClusterWorkloadIdentityConfigArgs.builder()
                .workloadPool("my-project-name.svc.id.goog")
                .build())
            .addonsConfig(ClusterAddonsConfigArgs.builder()
                .gkeBackupAgentConfig(ClusterAddonsConfigGkeBackupAgentConfigArgs.builder()
                    .enabled(true)
                    .build())
                .build())
            .build());
        var basic = new BackupPlan("basic", BackupPlanArgs.builder()
            .cluster(primary.id())
            .location("us-central1")
            .backupConfig(BackupPlanBackupConfigArgs.builder()
                .includeVolumeData(true)
                .includeSecrets(true)
                .allNamespaces(true)
                .build())
            .build());
        var renameNs = new RestorePlan("renameNs", RestorePlanArgs.builder()
            .location("us-central1")
            .backupPlan(basic.id())
            .cluster(primary.id())
            .restoreConfig(RestorePlanRestoreConfigArgs.builder()
                .selectedNamespaces(RestorePlanRestoreConfigSelectedNamespacesArgs.builder()
                    .namespaces("ns1")
                    .build())
                .namespacedResourceRestoreMode("FAIL_ON_CONFLICT")
                .volumeDataRestorePolicy("REUSE_VOLUME_HANDLE_FROM_BACKUP")
                .clusterResourceRestoreScope(RestorePlanRestoreConfigClusterResourceRestoreScopeArgs.builder()
                    .noGroupKinds(true)
                    .build())
                .transformationRules(
                    RestorePlanRestoreConfigTransformationRuleArgs.builder()
                        .description("rename namespace from ns1 to ns2")
                        .resourceFilter(RestorePlanRestoreConfigTransformationRuleResourceFilterArgs.builder()
                            .groupKinds(RestorePlanRestoreConfigTransformationRuleResourceFilterGroupKindArgs.builder()
                                .resourceKind("Namespace")
                                .build())
                            .jsonPath(".metadata[?(@.name == 'ns1')]")
                            .build())
                        .fieldActions(RestorePlanRestoreConfigTransformationRuleFieldActionArgs.builder()
                            .op("REPLACE")
                            .path("/metadata/name")
                            .value("ns2")
                            .build())
                        .build(),
                    RestorePlanRestoreConfigTransformationRuleArgs.builder()
                        .description("move all resources from ns1 to ns2")
                        .resourceFilter(RestorePlanRestoreConfigTransformationRuleResourceFilterArgs.builder()
                            .namespaces("ns1")
                            .build())
                        .fieldActions(RestorePlanRestoreConfigTransformationRuleFieldActionArgs.builder()
                            .op("REPLACE")
                            .path("/metadata/namespace")
                            .value("ns2")
                            .build())
                        .build())
                .build())
            .build());
    }
}
Content copied to clipboard

Gkebackup Restoreplan Second Transformation

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.container.Cluster;
import com.pulumi.gcp.container.ClusterArgs;
import com.pulumi.gcp.container.inputs.ClusterWorkloadIdentityConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigArgs;
import com.pulumi.gcp.container.inputs.ClusterAddonsConfigGkeBackupAgentConfigArgs;
import com.pulumi.gcp.gkebackup.BackupPlan;
import com.pulumi.gcp.gkebackup.BackupPlanArgs;
import com.pulumi.gcp.gkebackup.inputs.BackupPlanBackupConfigArgs;
import com.pulumi.gcp.gkebackup.RestorePlan;
import com.pulumi.gcp.gkebackup.RestorePlanArgs;
import com.pulumi.gcp.gkebackup.inputs.RestorePlanRestoreConfigArgs;
import com.pulumi.gcp.gkebackup.inputs.RestorePlanRestoreConfigExcludedNamespacesArgs;
import com.pulumi.gcp.gkebackup.inputs.RestorePlanRestoreConfigClusterResourceRestoreScopeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var primary = new Cluster("primary", ClusterArgs.builder()
            .location("us-central1")
            .initialNodeCount(1)
            .workloadIdentityConfig(ClusterWorkloadIdentityConfigArgs.builder()
                .workloadPool("my-project-name.svc.id.goog")
                .build())
            .addonsConfig(ClusterAddonsConfigArgs.builder()
                .gkeBackupAgentConfig(ClusterAddonsConfigGkeBackupAgentConfigArgs.builder()
                    .enabled(true)
                    .build())
                .build())
            .build());
        var basic = new BackupPlan("basic", BackupPlanArgs.builder()
            .cluster(primary.id())
            .location("us-central1")
            .backupConfig(BackupPlanBackupConfigArgs.builder()
                .includeVolumeData(true)
                .includeSecrets(true)
                .allNamespaces(true)
                .build())
            .build());
        var transformRule = new RestorePlan("transformRule", RestorePlanArgs.builder()
            .description("copy nginx env variables")
            .labels(Map.of("app", "nginx"))
            .location("us-central1")
            .backupPlan(basic.id())
            .cluster(primary.id())
            .restoreConfig(RestorePlanRestoreConfigArgs.builder()
                .excludedNamespaces(RestorePlanRestoreConfigExcludedNamespacesArgs.builder()
                    .namespaces("my-ns")
                    .build())
                .namespacedResourceRestoreMode("DELETE_AND_RESTORE")
                .volumeDataRestorePolicy("RESTORE_VOLUME_DATA_FROM_BACKUP")
                .clusterResourceRestoreScope(RestorePlanRestoreConfigClusterResourceRestoreScopeArgs.builder()
                    .excludedGroupKinds(RestorePlanRestoreConfigClusterResourceRestoreScopeExcludedGroupKindArgs.builder()
                        .resourceGroup("apiextension.k8s.io")
                        .resourceKind("CustomResourceDefinition")
                        .build())
                    .build())
                .clusterResourceConflictPolicy("USE_EXISTING_VERSION")
                .transformationRules(RestorePlanRestoreConfigTransformationRuleArgs.builder()
                    .description("Copy environment variables from the nginx container to the install init container.")
                    .resourceFilter(RestorePlanRestoreConfigTransformationRuleResourceFilterArgs.builder()
                        .groupKinds(RestorePlanRestoreConfigTransformationRuleResourceFilterGroupKindArgs.builder()
                            .resourceKind("Pod")
                            .resourceGroup("")
                            .build())
                        .jsonPath(".metadata[?(@.name == 'nginx')]")
                        .build())
                    .fieldActions(RestorePlanRestoreConfigTransformationRuleFieldActionArgs.builder()
                        .op("COPY")
                        .path("/spec/initContainers/0/env")
                        .fromPath("/spec/containers/0/env")
                        .build())
                    .build())
                .build())
            .build());
    }
}
Content copied to clipboard

Import

RestorePlan can be imported using any of these accepted formats

$ pulumi import gcp:gkebackup/restorePlan:RestorePlan default projects/{{project}}/locations/{{location}}/restorePlans/{{name}}
Content copied to clipboard
$ pulumi import gcp:gkebackup/restorePlan:RestorePlan default {{project}}/{{location}}/{{name}}
Content copied to clipboard
$ pulumi import gcp:gkebackup/restorePlan:RestorePlan default {{location}}/{{name}}
Content copied to clipboard

Properties

Link copied to clipboard
val backupPlan: Output<String>

A reference to the BackupPlan from which Backups may be used as the source for Restores created via this RestorePlan.

Link copied to clipboard
val cluster: Output<String>

The source cluster from which Restores will be created via this RestorePlan.

Link copied to clipboard
val description: Output<String>?

User specified descriptive string for this RestorePlan.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val labels: Output<Map<String, String>>?

Description: A set of custom labels supplied by the user. A list of key->value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

Link copied to clipboard
val location: Output<String>

The region of the Restore Plan.

Link copied to clipboard
val name: Output<String>

The full name of the BackupPlan Resource.

Link copied to clipboard
val project: Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val restoreConfig: Output<RestorePlanRestoreConfig>

Defines the configuration of Restores created via this RestorePlan. Structure is documented below.

Link copied to clipboard
val state: Output<String>

The State of the RestorePlan.

Link copied to clipboard
val stateReason: Output<String>

Detailed description of why RestorePlan is in its current state.

Link copied to clipboard
val uid: Output<String>

Server generated, unique identifier of UUID format.

Link copied to clipboard
val urn: Output<String>