diff --git a/docs/master/quick-start.md b/docs/master/quick-start.md index f4b5ade5..1a10f1f6 100644 --- a/docs/master/quick-start.md +++ b/docs/master/quick-start.md @@ -97,13 +97,13 @@ GCP provides MySQL databases using [CloudSQL] instances. Crossplane uses a resource and claim pattern to provision and manage cloud resources like CloudSQL instances - if you've ever used [persistent volumes in Kubernetes] you've seen this pattern before. The simplest way to start using a new MySQL instance on GCP -is to provision a `CloudsqlInstance`, then claim it via a `MySQLInstance`. We +is to provision a `CloudSQLInstance`, then claim it via a `MySQLInstance`. We call this process _static provisioning_. ```yaml apiVersion: database.gcp.crossplane.io/v1beta1 -kind: CloudsqlInstance +kind: CloudSQLInstance metadata: name: example-cloudsql-instance spec: @@ -130,7 +130,7 @@ apply it: kubectl apply -f cloudsql.yaml ``` -Crossplane is now creating the `CloudsqlInstance`! Before we can use it, we need +Crossplane is now creating the `CloudSQLInstance`! Before we can use it, we need to claim it. ```yaml @@ -141,7 +141,7 @@ metadata: spec: resourceRef: apiVersion: database.gcp.crossplane.io/v1beta1 - kind: CloudsqlInstance + kind: CloudSQLInstance name: example-cloudsql-instance writeConnectionSecretToRef: name: example-mysql-connection-details @@ -153,7 +153,7 @@ Save the above as `mysql.yaml`, and once again apply it: kubectl --namespace default apply -f mysql.yaml ``` -In Crossplane cloud provider specific resources like the `CloudsqlInstance` we +In Crossplane cloud provider specific resources like the `CloudSQLInstance` we created above are called _managed resources_. They're considered infrastructure, like a Kubernetes `Node` or `PersistentVolume`. Managed resources exist at the cluster scope (they're not namespaced) and let you specify nitty-gritty provider @@ -173,7 +173,7 @@ use! ```bash $ kubectl --namespace default get mysqlinstance example-mysql-claim NAME STATUS CLASS-KIND CLASS-NAME RESOURCE-KIND RESOURCE-NAME AGE -example-mysql-claim Bound CloudsqlInstance example-cloudsql-instance 4m +example-mysql-claim Bound CloudSQLInstance example-cloudsql-instance 4m ``` You'll find all the details you need to connect to your new MySQL instance saved @@ -202,7 +202,7 @@ serverCACertificateCert: 1272 bytes ``` That's all there is to static provisioning with Crossplane! We've created a -`CloudsqlInstance` as cluster scoped infrastructure, then claimed it as a +`CloudSQLInstance` as cluster scoped infrastructure, then claimed it as a `MySQLInstance`. You can use `kubectl describe` to view the detailed configuration and status of your `CloudSqlInstance`. @@ -211,7 +211,7 @@ $ kubectl describe example-cloudsql-instance Name: example-cloudsql-instance Annotations: crossplane.io/external-name: example-cloudsql-instance API Version: database.gcp.crossplane.io/v1beta1 -Kind: CloudsqlInstance +Kind: CloudSQLInstance Spec: For Provider: Database Version: MYSQL_5_6 @@ -281,7 +281,7 @@ the same settings as the `CloudSqlInstance` we provisioned earlier in the guide: ```yaml apiVersion: database.gcp.crossplane.io/v1beta1 -kind: CloudsqlInstanceClass +kind: CloudSQLInstanceClass metadata: name: example-cloudsql-class annotations: @@ -335,11 +335,11 @@ mysqlinstance.database.crossplane.io/example-mysql-dynamic-claim created $ kubectl get mysqlinstance example-mysql-dynamic-claim NAME STATUS CLASS-KIND CLASS-NAME RESOURCE-KIND RESOURCE-NAME AGE -example-mysql-dynamic-claim CloudsqlInstanceClass example-cloudsql-class CloudsqlInstance default-example-mysql-dynamic-claim-bwpzd 47s +example-mysql-dynamic-claim CloudSQLInstanceClass example-cloudsql-class CloudSQLInstance default-example-mysql-dynamic-claim-bwpzd 47s ``` -You just dynamically provisioned a `CloudsqlInstance`! You can find the name of -your new `CloudsqlInstance` under the `RESOURCE-NAME` column when you run +You just dynamically provisioned a `CloudSQLInstance`! You can find the name of +your new `CloudSQLInstance` under the `RESOURCE-NAME` column when you run `kubectl describe mysqlinstance`. Reuse the resource class as many times as you like; simply submit more `MySQLInstance` resource claims to create more CloudSQL instances. diff --git a/docs/master/services-guide.md b/docs/master/services-guide.md index 7eb48b04..23f56c04 100644 --- a/docs/master/services-guide.md +++ b/docs/master/services-guide.md @@ -285,7 +285,7 @@ cloudsql--mysql-standard.yaml ```yaml --- apiVersion: database.gcp.crossplane.io/v1beta1 -kind: CloudsqlInstanceClass +kind: CloudSQLInstanceClass metadata: name: cloudsql-mysql-standard namespace: gcp-infra-dev diff --git a/docs/master/services/aws-services-guide.md b/docs/master/services/aws-services-guide.md index 63280868..a7f09f7b 100644 --- a/docs/master/services/aws-services-guide.md +++ b/docs/master/services/aws-services-guide.md @@ -674,7 +674,7 @@ Spec: Engine Version: 5.6 Resource Ref: API Version: database.aws.crossplane.io/v1alpha2 - Kind: MysqlServer + Kind: MySQLServer Name: mysqlinstance-6a7fe064-d888-11e9-ab90-42b6bb22213a Namespace: aws-infra-dev Write Connection Secret To Ref: diff --git a/docs/master/services/azure-services-guide.md b/docs/master/services/azure-services-guide.md index 65af6cd7..517d615a 100644 --- a/docs/master/services/azure-services-guide.md +++ b/docs/master/services/azure-services-guide.md @@ -421,7 +421,7 @@ Spec: Engine Version: 5.6 Resource Ref: API Version: database.azure.crossplane.io/v1alpha2 - Kind: MysqlServer + Kind: MySQLServer Name: mysqlinstance-6a7fe064-d888-11e9-ab90-42b6bb22213a Namespace: azure-infra-dev Write Connection Secret To Ref: @@ -471,14 +471,14 @@ Rule][azure-vnet-rule]. export MYSQL_NAME=$(kubectl get -o json mysqlinstance mysql-claim -n app-project1-dev | jq -j '.spec.resourceRef.name') ``` -* Define a `MysqlServerVirtualNetworkRule` in `wordpress-vnet-rule.yaml` and +* Define a `MySQLServerVirtualNetworkRule` in `wordpress-vnet-rule.yaml` and create it: ```yaml cat > wordpress-vnet-rule.yaml < gcp-mysql-standard.yaml < Portable classes are the resource classes that are not cloud specific and their purpose is to refer to cloud specific resource classes that will be used for provisioning. For example, MySQLInstanceClass is a portable class -that can refer to CloudsqlInstanceClass (GCP) or RDSInstanceClass (AWS). +that can refer to CloudSQLInstanceClass (GCP) or RDSInstanceClass (AWS). You may specify *one* instance of a portable class kind as *default* in each namespace. This means that the portable resource class instance will be applied @@ -374,7 +374,7 @@ Spec: Engine Version: 5.6 Resource Ref: API Version: database.gcp.crossplane.io/v1beta1 - Kind: CloudsqlInstance + Kind: CloudSQLInstance Name: mysqlinstance-6a7fe064-d888-11e9-ab90-42b6bb22213a Namespace: gcp-infra-dev Write Connection Secret To Ref: diff --git a/docs/master/stacks-guide-azure.md b/docs/master/stacks-guide-azure.md index b88dbe22..83af18a5 100644 --- a/docs/master/stacks-guide-azure.md +++ b/docs/master/stacks-guide-azure.md @@ -425,7 +425,7 @@ exists, and will create the rule if so. ```bash cat > vnet-rule.yaml <