From 804b3bce009f068cdce883971f82b1538bb62ab9 Mon Sep 17 00:00:00 2001 From: Crossplane Date: Wed, 30 Sep 2020 19:06:26 +0000 Subject: [PATCH] docs snapshot for crossplane version `master` --- .../cloud-providers/aws/aws-provider.md | 3 -- .../getting-started/compose-infrastructure.md | 50 +++++++++---------- .../getting-started/install-configure.md | 3 +- .../provision-infrastructure.md | 2 +- docs/master/reference/install.md | 2 +- .../compose/composition-aws-with-vpc.yaml | 28 +++++++---- .../snippets/compose/composition-aws.yaml | 3 +- .../snippets/configure/aws/provider.yaml | 1 - docs/master/snippets/configure/aws/setup.sh | 9 ---- docs/master/snippets/provision/aws.yaml | 1 + 10 files changed, 49 insertions(+), 53 deletions(-) diff --git a/docs/master/cloud-providers/aws/aws-provider.md b/docs/master/cloud-providers/aws/aws-provider.md index 4019ea38..80f9332a 100644 --- a/docs/master/cloud-providers/aws/aws-provider.md +++ b/docs/master/cloud-providers/aws/aws-provider.md @@ -77,8 +77,6 @@ To store the credentials as a secret, run: ```bash # retrieve profile's credentials, save it under 'default' profile, and base64 encode it BASE64ENCODED_AWS_ACCOUNT_CREDS=$(echo -e "[default]\naws_access_key_id = $(aws configure get aws_access_key_id --profile $aws_profile)\naws_secret_access_key = $(aws configure get aws_secret_access_key --profile $aws_profile)" | base64 | tr -d "\n") -# retrieve the profile's region from config -AWS_REGION=$(aws configure get region --profile ${aws_profile}) ``` At this point, the region and the encoded credentials are stored in respective @@ -101,7 +99,6 @@ kind: ProviderConfig metadata: name: aws-provider spec: - region: ${AWS_REGION} credentialsSecretRef: namespace: crossplane-system name: aws-account-creds diff --git a/docs/master/getting-started/compose-infrastructure.md b/docs/master/getting-started/compose-infrastructure.md index bc76a988..96e0b904 100644 --- a/docs/master/getting-started/compose-infrastructure.md +++ b/docs/master/getting-started/compose-infrastructure.md @@ -31,17 +31,6 @@ create a connection `Secret` with keys for `username`, `password`, and `endpoint`. We will then create a `Composition` for each provider that can satisfy a `PostgreSQLInstance`. Let's get started! -## Grant RBAC Permissions - -Crossplane must be granted RBAC permissions to manage new infrastructure types -that we define. This is covered in greater detail in the [composition] section, -but you can easily run the following command now to grant all necessary RBAC -permissions for the remainder of this quick start guide: - -```console -kubectl apply -f https://raw.githubusercontent.com/crossplane/crossplane/master/docs/snippets/compose/clusterrole.yaml -``` - ## Create CompositeResourceDefinition The next step is authoring an XRD that defines a `CompositePostgreSQLInstance`: @@ -157,6 +146,7 @@ spec: kind: RDSInstance spec: forProvider: + region: us-east-1 dbInstanceClass: db.t2.small masterUsername: masteruser engine: postgres @@ -215,6 +205,7 @@ spec: kind: VPC spec: forProvider: + region: us-east-1 cidrBlock: 192.168.0.0/16 enableDnsSupport: true enableDnsHostNames: true @@ -225,13 +216,14 @@ spec: kind: Subnet metadata: labels: - zone: us-west-2a + zone: us-east-1a spec: forProvider: + region: us-east-1 cidrBlock: 192.168.64.0/18 vpcIdSelector: matchControllerRef: true - availabilityZone: us-west-2a + availabilityZone: us-east-1a providerConfigRef: name: aws-provider - base: @@ -239,13 +231,14 @@ spec: kind: Subnet metadata: labels: - zone: us-west-2b + zone: us-east-1b spec: forProvider: + region: us-east-1 cidrBlock: 192.168.128.0/18 vpcIdSelector: matchControllerRef: true - availabilityZone: us-west-2b + availabilityZone: us-east-1b providerConfigRef: name: aws-provider - base: @@ -253,13 +246,14 @@ spec: kind: Subnet metadata: labels: - zone: us-west-2c + zone: us-east-1c spec: forProvider: + region: us-east-1 cidrBlock: 192.168.192.0/18 vpcIdSelector: matchControllerRef: true - availabilityZone: us-west-2c + availabilityZone: us-east-1c providerConfigRef: name: aws-provider - base: @@ -267,6 +261,7 @@ spec: kind: DBSubnetGroup spec: forProvider: + region: us-east-1 description: An excellent formation of subnetworks. subnetIdSelector: matchControllerRef: true @@ -277,6 +272,7 @@ spec: kind: InternetGateway spec: forProvider: + region: us-east-1 vpcIdSelector: matchControllerRef: true providerConfigRef: @@ -286,7 +282,7 @@ spec: kind: RouteTable spec: forProvider: - region: us-west-2 + region: us-east-1 vpcIdSelector: matchControllerRef: true routes: @@ -296,13 +292,13 @@ spec: associations: - subnetIdSelector: matchLabels: - zone: us-west-2a + zone: us-east-1a - subnetIdSelector: matchLabels: - zone: us-west-2b + zone: us-east-1b - subnetIdSelector: matchLabels: - zone: us-west-2c + zone: us-east-1c providerConfigRef: name: aws-provider - base: @@ -310,6 +306,7 @@ spec: kind: SecurityGroup spec: forProvider: + region: us-east-1 vpcIdSelector: matchControllerRef: true groupName: crossplane-getting-started @@ -328,6 +325,7 @@ spec: kind: RDSInstance spec: forProvider: + region: us-east-1 dbSubnetGroupNameSelector: matchControllerRef: true vpcSecurityGroupIDSelector: @@ -713,10 +711,12 @@ kubectl get postgresqlinstances.database.example.org my-db > may want to look at other resources in your cluster. The following commands > will allow you to view groups of Crossplane resources: > +> - `kubectl get claim`: get all resources of all claim kinds, like `PostgreSQLInstance`. +> - `kubectl get composite`: get all resources that are of composite kind, like `CompositePostgreSQLInstance`. > - `kubectl get managed`: get all resources that represent a unit of external -> infrastructure -> - `kubectl get `: get all resources related to `` -> - `kubectl get crossplane`: get all resources related to Crossplane +> infrastructure. +> - `kubectl get `: get all resources related to ``. +> - `kubectl get crossplane`: get all resources related to Crossplane. You should also see a `Secret` in the `default` namespace named `db-conn` that contains fields for `username`, `password`, and `endpoint`: @@ -811,7 +811,7 @@ alongside your [OAM] application manifests. -[last section]: provision-infrastructure.yaml +[last section]: provision-infrastructure.md [composition]: ../introduction/composition.md [next section]: run-applications.md [OAM]: https://oam.dev/ diff --git a/docs/master/getting-started/install-configure.md b/docs/master/getting-started/install-configure.md index b9577534..ec33dc99 100644 --- a/docs/master/getting-started/install-configure.md +++ b/docs/master/getting-started/install-configure.md @@ -88,7 +88,7 @@ kubectl create namespace crossplane-system helm repo add crossplane-master https://charts.crossplane.io/master/ helm search repo crossplane-master --devel -helm install crossplane --namespace crossplane-system crossplane-master/crossplane --version --devel +helm install crossplane --namespace crossplane-system crossplane-master/crossplane --devel --version ``` For example: @@ -155,7 +155,6 @@ kind: ProviderConfig metadata: name: aws-provider spec: - region: us-west-2 credentialsSecretRef: namespace: crossplane-system name: aws-creds diff --git a/docs/master/getting-started/provision-infrastructure.md b/docs/master/getting-started/provision-infrastructure.md index a69ae264..4cec0c50 100644 --- a/docs/master/getting-started/provision-infrastructure.md +++ b/docs/master/getting-started/provision-infrastructure.md @@ -241,4 +241,4 @@ APIs of our choosing in the [next section]. [Azure Database for PostgreSQL]: https://azure.microsoft.com/en-us/services/postgresql/ [Resource Group]: https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-portal#what-is-a-resource-group [ApsaraDB for RDS]: https://www.alibabacloud.com/product/apsaradb-for-rds-postgresql -[next section]: publish-infrastructure.md +[next section]: compose-infrastructure.md diff --git a/docs/master/reference/install.md b/docs/master/reference/install.md index 233f9ff6..f77e3827 100644 --- a/docs/master/reference/install.md +++ b/docs/master/reference/install.md @@ -49,7 +49,7 @@ kubectl create namespace crossplane-system helm repo add crossplane-master https://charts.crossplane.io/master/ helm search repo crossplane-master --devel -helm install crossplane --namespace crossplane-system crossplane-master/crossplane --version --devel +helm install crossplane --namespace crossplane-system crossplane-master/crossplane --devel --version ``` ## Uninstalling the Chart diff --git a/docs/master/snippets/compose/composition-aws-with-vpc.yaml b/docs/master/snippets/compose/composition-aws-with-vpc.yaml index 112a3461..35df16b4 100644 --- a/docs/master/snippets/compose/composition-aws-with-vpc.yaml +++ b/docs/master/snippets/compose/composition-aws-with-vpc.yaml @@ -18,6 +18,7 @@ spec: kind: VPC spec: forProvider: + region: us-east-1 cidrBlock: 192.168.0.0/16 enableDnsSupport: true enableDnsHostNames: true @@ -28,13 +29,14 @@ spec: kind: Subnet metadata: labels: - zone: us-west-2a + zone: us-east-1a spec: forProvider: + region: us-east-1 cidrBlock: 192.168.64.0/18 vpcIdSelector: matchControllerRef: true - availabilityZone: us-west-2a + availabilityZone: us-east-1a providerConfigRef: name: aws-provider - base: @@ -42,13 +44,14 @@ spec: kind: Subnet metadata: labels: - zone: us-west-2b + zone: us-east-1b spec: forProvider: + region: us-east-1 cidrBlock: 192.168.128.0/18 vpcIdSelector: matchControllerRef: true - availabilityZone: us-west-2b + availabilityZone: us-east-1b providerConfigRef: name: aws-provider - base: @@ -56,13 +59,14 @@ spec: kind: Subnet metadata: labels: - zone: us-west-2c + zone: us-east-1c spec: forProvider: + region: us-east-1 cidrBlock: 192.168.192.0/18 vpcIdSelector: matchControllerRef: true - availabilityZone: us-west-2c + availabilityZone: us-east-1c providerConfigRef: name: aws-provider - base: @@ -70,6 +74,7 @@ spec: kind: DBSubnetGroup spec: forProvider: + region: us-east-1 description: An excellent formation of subnetworks. subnetIdSelector: matchControllerRef: true @@ -80,6 +85,7 @@ spec: kind: InternetGateway spec: forProvider: + region: us-east-1 vpcIdSelector: matchControllerRef: true providerConfigRef: @@ -89,7 +95,7 @@ spec: kind: RouteTable spec: forProvider: - region: us-west-2 + region: us-east-1 vpcIdSelector: matchControllerRef: true routes: @@ -99,13 +105,13 @@ spec: associations: - subnetIdSelector: matchLabels: - zone: us-west-2a + zone: us-east-1a - subnetIdSelector: matchLabels: - zone: us-west-2b + zone: us-east-1b - subnetIdSelector: matchLabels: - zone: us-west-2c + zone: us-east-1c providerConfigRef: name: aws-provider - base: @@ -113,6 +119,7 @@ spec: kind: SecurityGroup spec: forProvider: + region: us-east-1 vpcIdSelector: matchControllerRef: true groupName: crossplane-getting-started @@ -131,6 +138,7 @@ spec: kind: RDSInstance spec: forProvider: + region: us-east-1 dbSubnetGroupNameSelector: matchControllerRef: true vpcSecurityGroupIDSelector: diff --git a/docs/master/snippets/compose/composition-aws.yaml b/docs/master/snippets/compose/composition-aws.yaml index 99618a22..0b8a493e 100644 --- a/docs/master/snippets/compose/composition-aws.yaml +++ b/docs/master/snippets/compose/composition-aws.yaml @@ -18,6 +18,7 @@ spec: kind: RDSInstance spec: forProvider: + region: us-east-1 dbInstanceClass: db.t2.small masterUsername: masteruser engine: postgres @@ -41,4 +42,4 @@ spec: - fromConnectionSecretKey: username - fromConnectionSecretKey: password - fromConnectionSecretKey: endpoint - - fromConnectionSecretKey: port \ No newline at end of file + - fromConnectionSecretKey: port diff --git a/docs/master/snippets/configure/aws/provider.yaml b/docs/master/snippets/configure/aws/provider.yaml index 73f70266..2fe884c4 100644 --- a/docs/master/snippets/configure/aws/provider.yaml +++ b/docs/master/snippets/configure/aws/provider.yaml @@ -17,4 +17,3 @@ spec: namespace: crossplane-system name: aws-account-creds key: credentials - region: ((AWS_REGION)) diff --git a/docs/master/snippets/configure/aws/setup.sh b/docs/master/snippets/configure/aws/setup.sh index 29538a0a..f2f54079 100755 --- a/docs/master/snippets/configure/aws/setup.sh +++ b/docs/master/snippets/configure/aws/setup.sh @@ -35,17 +35,9 @@ kubectl cluster-info > /dev/null || echo "KUBECONFIG is not configured properly" # if aws_profile is not provided, use default aws_profile="${aws_profile:-default}" -# if region is not provided, retrieve aws profile region from config -AWS_REGION=$(aws configure get region --profile $aws_profile) - # retrieve aws profile credentials, save it under 'default' profile, and base64 encode it AWS_CREDS_BASE64=$(echo -e "[default]\naws_access_key_id = $(aws configure get aws_access_key_id --profile $aws_profile)\naws_secret_access_key = $(aws configure get aws_secret_access_key --profile $aws_profile)" | base64 | tr -d "\n") -if test -z "$AWS_REGION"; then - echo "error retrieving region from aws config. " - exit -1 -fi - if test -z "$AWS_CREDS_BASE64"; then echo "error reading credentials from aws config" exit -1 @@ -53,6 +45,5 @@ fi # build the secret and provider objects, and then apply it cat provider.yaml | sed \ - -e "s|((AWS_REGION))|"$AWS_REGION"|g" \ -e "s|((AWS_CREDS_BASE64))|"$AWS_CREDS_BASE64"|g" \ | kubectl apply -f - \ No newline at end of file diff --git a/docs/master/snippets/provision/aws.yaml b/docs/master/snippets/provision/aws.yaml index 090c48d3..1bb98633 100644 --- a/docs/master/snippets/provision/aws.yaml +++ b/docs/master/snippets/provision/aws.yaml @@ -4,6 +4,7 @@ metadata: name: rdspostgresql spec: forProvider: + region: us-east-1 dbInstanceClass: db.t2.small masterUsername: masteruser allocatedStorage: 20