diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8f9b7399b..02a31fa39 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,7 @@ The cloud prefix can be one of: - `digitalocean` for [DigitalOcean](https://github.com/pulumi/pulumi-digitalocean/) - `f5bigip` for [F5's BIG-IP](https://github.com/pulumi/pulumi-f5bigip/) - `cloud` for [Pulumi's cross-cloud programming framework](https://github.com/pulumi/pulumi-cloud), which is currently in preview -- Any [cloud provider](https://www.pulumi.com/docs/reference/pkg/#cloud-providers) with a dedicated Pulumi package +- Any [cloud provider](https://www.pulumi.com/registry) with a dedicated Pulumi package The language prefix can be one of: - `ts` for TypeScript @@ -69,4 +69,3 @@ Each example should include a README to give the readers a good walkthrough. It See our [example README template](example-readme-template.md.txt) for detailed explanations on each section. > The contribution guidelines have been authored in September 2019 and are subject to further refinements and tweaks. Examples prior to September 2019 do not necessarily conform to these guidelines. - diff --git a/aws-py-wordpress-fargate-rds/README.md b/aws-py-wordpress-fargate-rds/README.md index 3d544b17a..c6cdfca91 100644 --- a/aws-py-wordpress-fargate-rds/README.md +++ b/aws-py-wordpress-fargate-rds/README.md @@ -5,7 +5,7 @@ This example serves a WordPress site in AWS ECS Fargate using an RDS MySQL Backe It leverages the following Pulumi concepts/constructs: - [Component Resources](https://www.pulumi.com/docs/intro/concepts/programming-model/#components): Allows one to create custom resources that encapsulate one's best practices. In this example, component resource is used to define a "VPC" custom resource, a "Backend" custom resource that sets up the RDS DB, and a "Frontend" resource that sets up the ECS cluster and load balancer and tasks. -- [Other Providers](https://www.pulumi.com/docs/reference/pkg/): Beyond the providers for the various clouds and Kubernetes, etc, Pulumi allows one to create and manage non-cloud resources. In this case, the program uses the Random provider to create a random password if necessary. +- [Other Providers](https://www.pulumi.com/registry/): Beyond the providers for the various clouds and Kubernetes, etc, Pulumi allows one to create and manage non-cloud resources. In this case, the program uses the Random provider to create a random password if necessary. This sample uses the following AWS products (and related Pulumi providers): diff --git a/aws-ts-vpc-with-ecs-fargate-py/ecs-fargate-python/__main__.py b/aws-ts-vpc-with-ecs-fargate-py/ecs-fargate-python/__main__.py index ac83e04df..25df32f51 100644 --- a/aws-ts-vpc-with-ecs-fargate-py/ecs-fargate-python/__main__.py +++ b/aws-ts-vpc-with-ecs-fargate-py/ecs-fargate-python/__main__.py @@ -31,7 +31,7 @@ "vpc_name": pulumi_vpc_name, "vpc_cidr": pulumi_vpc_cidr, "pulumi:project": env_project, "pulumi:stack": env_stack} # Step 1.1: Create the Task Execution IAM Role https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs-cli-tutorial-fargate.html -# IAM Role: https://www.pulumi.com/docs/reference/pkg/aws/iam/role/ +# IAM Role: https://www.pulumi.com/registry/packages/aws/api-docs/iam/role/ task_execution_role = aws.iam.Role( "pulumi-fargate-task-execution-role", assume_role_policy=json.dumps( @@ -51,7 +51,7 @@ ) # Step 1.2 Attach the task execution role policy: https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs-cli-tutorial-fargate.html -# https://www.pulumi.com/docs/reference/pkg/aws/iam/rolepolicyattachment/ +# https://www.pulumi.com/registry/packages/aws/api-docs/iam/rolepolicyattachment/ task_execution_role_policy_attach = aws.iam.RolePolicyAttachment( "pulumi-fargate-task-excution-policy-attach", role=task_execution_role.name, @@ -59,7 +59,7 @@ ) # Step 3: Create a Cluster and Configure the Security Group https://docs.aws.amazon.com/AmazonECS/latest/userguide/ecs-cli-tutorial-fargate.html -# https://www.pulumi.com/docs/reference/pkg/aws/ec2/securitygroup/ +# https://www.pulumi.com/registry/packages/aws/api-docs/ec2/securitygroup/ # tags for security group sec_tags = dict(my_tags) @@ -85,23 +85,23 @@ cluster_tags.update({"Name": "pulumi-fargate-ecs-cluster"}) # Create an ECS cluster to run a container-based service. -# https://www.pulumi.com/docs/reference/pkg/aws/ecs/cluster/ +# https://www.pulumi.com/registry/packages/aws/api-docs/ecs/cluster/ cluster = aws.ecs.Cluster('pulumi-app-cluster', tags=cluster_tags) # 3. Create a load balancer to listen for requests and route them to the container. # AWS CLI install https://docs.aws.amazon.com/elasticloadbalancing/latest/application/tutorial-application-load-balancer-cli.html -# https://www.pulumi.com/docs/reference/pkg/aws/alb/loadbalancer/ +# https://www.pulumi.com/registry/packages/aws/api-docs/alb/loadbalancer/ # tags for Application Load Balancer (ALB) alb_tags = dict(my_tags) alb_tags.update({"Name": "pulumi-fargate-alb"}) -# Created application load balancer in public subnets https://www.pulumi.com/docs/reference/pkg/aws/alb/loadbalancer/ +# Created application load balancer in public subnets https://www.pulumi.com/registry/packages/aws/api-docs/alb/loadbalancer/ alb = aws.lb.LoadBalancer("pulumi-fargate-alb", subnets=pulumi_public_subnets, security_groups=[sgroup.id], tags=alb_tags) -# Create target group https://www.pulumi.com/docs/reference/pkg/aws/alb/targetgroup/ +# Create target group https://www.pulumi.com/registry/packages/aws/api-docs/alb/targetgroup/ alb_target_group = aws.lb.TargetGroup( "pulumi-fargate-alb-tg", port=80, @@ -110,7 +110,7 @@ vpc_id=pulumi_vpc_id ) -# Create Listener https://www.pulumi.com/docs/reference/pkg/aws/alb/listener/ +# Create Listener https://www.pulumi.com/registry/packages/aws/api-docs/alb/listener/ front_end_listener = aws.lb.Listener( "pulumi-fargate-listener", load_balancer_arn=alb.arn, @@ -126,7 +126,7 @@ task_definition_tags = dict(my_tags) task_definition_tags.update({"Name": "pulumi-fargate-task-definition"}) -# Task Definition https://www.pulumi.com/docs/reference/pkg/aws/ecs/taskdefinition/ +# Task Definition https://www.pulumi.com/registry/packages/aws/api-docs/ecs/taskdefinition/ task_definition = aws.ecs.TaskDefinition( "pulumi-fargate-task-definition", family='fargate-task-definition', @@ -151,7 +151,7 @@ service_tags = dict(my_tags) service_tags.update({"Name": "pulumi-fargate-service"}) -# ecs service https://www.pulumi.com/docs/reference/pkg/aws/ecs/service/ +# ecs service https://www.pulumi.com/registry/packages/aws/api-docs/ecs/service/ service = aws.ecs.Service( 'pulumi-fargate-service', cluster=cluster.arn, @@ -173,4 +173,4 @@ ) export('Load Balancer URL', alb.dns_name) -export("ECS Cluster Tags", cluster_tags) \ No newline at end of file +export("ECS Cluster Tags", cluster_tags) diff --git a/aws-ts-wordpress-fargate-rds/README.md b/aws-ts-wordpress-fargate-rds/README.md index d8ef3f805..7a7df3075 100644 --- a/aws-ts-wordpress-fargate-rds/README.md +++ b/aws-ts-wordpress-fargate-rds/README.md @@ -5,7 +5,7 @@ This example serves a WordPress site in AWS ECS Fargate using an RDS MySQL Backe It leverages the following Pulumi concepts/constructs: - [Component Resources](https://www.pulumi.com/docs/intro/concepts/programming-model/#components): Allows one to create custom resources that encapsulate one's best practices. In this example, component resource is used to define a "VPC" custom resource, a "Backend" custom resource that sets up the RDS DB, and a "Frontend" resource that sets up the ECS cluster and load balancer and tasks. -- [Other Providers](https://www.pulumi.com/docs/reference/pkg/): Beyond the providers for the various clouds and Kubernetes, etc, Pulumi allows one to create and manage non-cloud resources. In this case, the program uses the Random provider to create a random password if necessary. +- [Other Providers](https://www.pulumi.com/registry/): Beyond the providers for the various clouds and Kubernetes, etc, Pulumi allows one to create and manage non-cloud resources. In this case, the program uses the Random provider to create a random password if necessary. This sample uses the following AWS products (and related Pulumi providers): diff --git a/libvirt-py-vm/README.md b/libvirt-py-vm/README.md index 551f65070..1da5d3eff 100644 --- a/libvirt-py-vm/README.md +++ b/libvirt-py-vm/README.md @@ -2,8 +2,8 @@ # Using the Pulumi Libvirt Provider to Deploy a VM on a KVM Server -Deploys a KVM server in Azure and then deploys a small Linux VM on that KVM server. -It uses the Pulumi Libvirt provider (https://www.pulumi.com/docs/reference/pkg/libvirt/) and nested virtualization that is supported by certain Azure instance types to accomplish this. +Deploys a KVM server in Azure and then deploys a small Linux VM on that KVM server. +It uses the Pulumi Libvirt provider (https://www.pulumi.com/registry/packages/libvirt/) and nested virtualization that is supported by certain Azure instance types to accomplish this. ## Running the App @@ -11,7 +11,7 @@ It uses the Pulumi Libvirt provider (https://www.pulumi.com/docs/reference/pkg/l - Mac: `brew install libvirt` - Windows: See: https://libvirt.org/windows.html - Others: https://libvirt.org/downloads.html - + 1. Create a new stack: ``` @@ -54,8 +54,8 @@ It uses the Pulumi Libvirt provider (https://www.pulumi.com/docs/reference/pkg/l Duration: 3m36s ``` -1. Check the VM on the KVM host: - The stack generates an output that provides a string you can execute to run `virsh` remotely on the KVM host. +1. Check the VM on the KVM host: + The stack generates an output that provides a string you can execute to run `virsh` remotely on the KVM host. It will look something like ``` echo virsh list | ssh -i libvirt-ex-dev-kvm_server.priv kvmuser@1.2.3.4