Skip to content

Commit 438cf50

Browse files
authored
Merge pull request #773 from tr0njavolta/master
v1.16 Docs
2 parents 3bffefa + b4b9960 commit 438cf50

File tree

75 files changed

+23902
-2678
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+23902
-2678
lines changed

config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,8 +90,8 @@ security:
9090
# Global parameters accessible by any Page
9191
params:
9292
# The current "latest" version. Used in the version dropdown
93-
latest: "1.15"
94-
docs: true
93+
latest: "1.16"
94+
docs: true
9595
anchors:
9696
# Generate heading anchors for any heading between min and max
9797
min: 2

content/master/guides/import-existing-resources.md

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ weight: 200
55

66
If you have resources that are already provisioned in a Provider,
77
you can import them as managed resources and let Crossplane manage them.
8-
A managed resource's [`managementPolicies`]({{<ref "/v1.13/concepts/managed-resources#managementpolicies">}})
8+
A managed resource's [`managementPolicies`]({{<ref "/v1.16/concepts/managed-resources#managementpolicies">}})
99
field enables importing external resources into Crossplane.
1010

1111
Crossplane can import resources either [manually]({{<ref "#import-resources-manually">}})
@@ -14,17 +14,17 @@ or [automatically]({{<ref "#import-resources-automatically">}}).
1414
## Import resources manually
1515

1616
Crossplane can discover and import existing Provider resources by matching the
17-
`crossplane.io/external-name` annotation in a managed resource.
17+
`crossplane.io/external-name` annotation in a managed resource.
1818

1919
To import an existing external resource in a Provider, create a new managed
2020
resource with the `crossplane.io/external-name` annotation. Set the annotation
2121
value to the name of the resource in the Provider.
2222

23-
For example, to import an existing GCP Network named
23+
For example, to import an existing GCP Network named
2424
{{<hover label="annotation" line="5">}}my-existing-network{{</hover>}},
25-
create a new managed resource and use the
25+
create a new managed resource and use the
2626
{{<hover label="annotation" line="5">}}my-existing-network{{</hover>}} in the
27-
annotation.
27+
annotation.
2828

2929
```yaml {label="annotation",copy-lines="none"}
3030
apiVersion: compute.gcp.crossplane.io/v1beta1
@@ -34,14 +34,14 @@ metadata:
3434
crossplane.io/external-name: my-existing-network
3535
```
3636
37-
The {{<hover label="name" line="5">}}metadata.name{{</hover>}}
38-
field can be anything you want. For example,
39-
{{<hover label="name" line="5">}}imported-network{{</hover>}}.
37+
The {{<hover label="name" line="5">}}metadata.name{{</hover>}}
38+
field can be anything you want. For example,
39+
{{<hover label="name" line="5">}}imported-network{{</hover>}}.
4040
4141
{{< hint "note" >}}
42-
This name is the
42+
This name is the
4343
name of the Kubernetes object. It's not related to the resource name inside the
44-
Provider.
44+
Provider.
4545
{{< /hint >}}
4646
4747
```yaml {label="name",copy-lines="none"}
@@ -53,15 +53,15 @@ metadata:
5353
crossplane.io/external-name: my-existing-network
5454
```
5555
56-
Leave the
57-
{{<hover label="fp" line="8">}}spec.forProvider{{</hover>}} field empty.
58-
Crossplane imports the settings and automatically applies them to the managed
59-
resource.
56+
Leave the
57+
{{<hover label="fp" line="8">}}spec.forProvider{{</hover>}} field empty.
58+
Crossplane imports the settings and automatically applies them to the managed
59+
resource.
6060
6161
{{< hint "important" >}}
62-
If the managed resource has _required_ fields in the
62+
If the managed resource has _required_ fields in the
6363
{{<hover label="fp" line="8">}}spec.forProvider{{</hover>}} you must add it to
64-
the `forProvider` field.
64+
the `forProvider` field.
6565

6666
The values of those fields must match what's inside the Provider or Crossplane
6767
overwrites the existing values.
@@ -82,17 +82,17 @@ spec:
8282
Crossplane now controls and manages this imported resource. Any changes to the
8383
managed resource `spec` changes the external resource.
8484

85-
## Import resources automatically
85+
## Import resources automatically
8686

87-
Automatically import external resources with an `Observe` [management policy]({{<ref "/v1.13/concepts/managed-resources#managementpolicies">}}).
87+
Automatically import external resources with an `Observe` [management policy]({{<ref "/v1.16/concepts/managed-resources#managementpolicies">}}).
8888

8989
Crossplane imports observe only resources but never changes or deletes the
9090
resources.
9191

9292
{{<hint "important" >}}
93-
The managed resource `managementPolicies` option is a beta feature.
93+
The managed resource `managementPolicies` option is a beta feature.
9494

95-
The Provider determines support for management policies.
95+
The Provider determines support for management policies.
9696
Refer to the Provider's documentation to see if the Provider supports
9797
management policies.
9898
{{< /hint >}}
@@ -101,15 +101,15 @@ management policies.
101101
### Apply the Observe management policy
102102
<!-- vale on -->
103103

104-
Create a new managed resource matching the
105-
{{<hover label="oo-policy" line="1">}}apiVersion{{</hover>}} and
104+
Create a new managed resource matching the
105+
{{<hover label="oo-policy" line="1">}}apiVersion{{</hover>}} and
106106
{{<hover label="oo-policy" line="2">}}kind{{</hover>}} of the resource
107107
to import and add
108-
{{<hover label="oo-policy" line="4">}}managementPolicies: ["Observe"]{{</hover>}} to the
108+
{{<hover label="oo-policy" line="4">}}managementPolicies: ["Observe"]{{</hover>}} to the
109109
{{<hover label="oo-policy" line="3">}}spec{{</hover>}}
110110

111111
For example, to import a GCP SQL DatabaseInstance, create a new resource with
112-
the {{<hover label="oo-policy" line="4">}}managementPolicies: ["Observe"]{{</hover>}}
112+
the {{<hover label="oo-policy" line="4">}}managementPolicies: ["Observe"]{{</hover>}}
113113
set.
114114
```yaml {label="oo-policy",copy-lines="none"}
115115
apiVersion: sql.gcp.upbound.io/v1beta1
@@ -119,14 +119,14 @@ spec:
119119
```
120120

121121
### Add the external-name annotation
122-
Add the {{<hover label="oo-ex-name" line="5">}}crossplane.io/external-name{{</hover>}}
122+
Add the {{<hover label="oo-ex-name" line="5">}}crossplane.io/external-name{{</hover>}}
123123
annotation for the resource. This name must match the name inside the Provider.
124124

125-
For example, for a GCP database named
125+
For example, for a GCP database named
126126
{{<hover label="oo-ex-name" line="5">}}my-external-database{{</hover>}}, apply
127-
the
128-
{{<hover label="oo-ex-name" line="5">}}crossplane.io/external-name{{</hover>}}
129-
annotation with the value
127+
the
128+
{{<hover label="oo-ex-name" line="5">}}crossplane.io/external-name{{</hover>}}
129+
annotation with the value
130130
{{<hover label="oo-ex-name" line="5">}}my-external-database{{</hover>}}.
131131

132132
```yaml {label="oo-ex-name",copy-lines="none"}
@@ -140,10 +140,10 @@ spec:
140140
```
141141

142142
### Create a Kubernetes object name
143-
Create a {{<hover label="oo-name" line="4">}}name{{</hover>}} to use for the
144-
Kubernetes object.
143+
Create a {{<hover label="oo-name" line="4">}}name{{</hover>}} to use for the
144+
Kubernetes object.
145145

146-
For example, name the Kubernetes object
146+
For example, name the Kubernetes object
147147
{{<hover label="oo-name" line="4">}}my-imported-database{{</hover>}}.
148148

149149
```yaml {label="oo-name",copy-lines="none"}
@@ -159,11 +159,11 @@ spec:
159159

160160
### Identify a specific external resource
161161
If more than one resource inside the Provider shares the same name, identify the
162-
specific resource with a unique
163-
{{<hover line="9" label="oo-region">}}spec.forProvider{{</hover>}} field.
162+
specific resource with a unique
163+
{{<hover line="9" label="oo-region">}}spec.forProvider{{</hover>}} field.
164164

165-
For example, only import the GCP SQL database in the
166-
{{<hover line="10" label="oo-region">}}us-central1{{</hover>}} region.
165+
For example, only import the GCP SQL database in the
166+
{{<hover line="10" label="oo-region">}}us-central1{{</hover>}} region.
167167

168168
```yaml {label="oo-region"}
169169
apiVersion: sql.gcp.upbound.io/v1beta1
@@ -181,7 +181,7 @@ spec:
181181
### Apply the managed resource
182182

183183
Apply the new managed resource. Crossplane syncs the status of the external
184-
resource in the cloud with the newly created managed resource.
184+
resource in the cloud with the newly created managed resource.
185185

186186
### View the discovered resource
187187
Crossplane discovers the managed resource and populates the
@@ -229,13 +229,13 @@ status:
229229
```
230230
<!-- vale off -->
231231
## Control imported ObserveOnly resources
232-
<!-- vale on -->
232+
<!-- vale on -->
233233

234-
Crossplane can take active control of observe only imported resources by
234+
Crossplane can take active control of observe only imported resources by
235235
changing the `managementPolicies` after import.
236236

237237
Change the {{<hover label="fc" line="8">}}managementPolicies{{</hover>}} field
238-
of the managed resource to
238+
of the managed resource to
239239
{{<hover label="fc" line="8">}}["*"]{{</hover>}}.
240240

241241
Copy any required parameter values from
@@ -281,5 +281,5 @@ status:
281281
type: Synced
282282
```
283283

284-
Crossplane now fully manages the imported resource. Crossplane applies any
285-
changes to the managed resource in the Provider's external resource.
284+
Crossplane now fully manages the imported resource. Crossplane applies any
285+
changes to the managed resource in the Provider's external resource.

0 commit comments

Comments
 (0)