Skip to content

Commit 40f768e

Browse files
committed
Add consistent backticks for Kubernetes resource types
Apply backticks to Kubernetes resource types (Operation, Ingress, ClusterRole, Job) to follow documentation style conventions for API objects per Jared's feedback in PR #956. Signed-off-by: Nic Cope <[email protected]>
1 parent 02df3da commit 40f768e

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

content/master/get-started/get-started-with-operations.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ alphaVersion: 2.0
66
---
77

88
This guide shows how to use Crossplane Operations to automate day-two
9-
operational tasks. You create an Operation that checks SSL certificate
9+
operational tasks. You create an `Operation` that checks SSL certificate
1010
expiry for a website.
1111

1212
**Crossplane calls this _Operations_.** Operations run function pipelines to
1313
perform tasks that don't fit the typical resource creation pattern - like
1414
certificate monitoring, rolling upgrades, or scheduled maintenance.
1515

16-
An Operation looks like this:
16+
An `Operation` looks like this:
1717

1818
```yaml
1919
apiVersion: ops.crossplane.io/v1alpha1
@@ -60,15 +60,15 @@ spec:
6060
```
6161
6262
<!-- vale Crossplane.Spelling = NO -->
63-
**The Operation runs once to completion, like a Kubernetes Job.**
63+
**The `Operation` runs once to completion, like a Kubernetes `Job`.**
6464
<!-- vale Crossplane.Spelling = YES -->
6565

66-
When you create the Operation, Crossplane runs the function pipeline. The
66+
When you create the `Operation`, Crossplane runs the function pipeline. The
6767
function checks SSL certificate expiry for google.com and returns the results
6868
in the operation's output.
6969

7070
This basic example shows the concept. In the walkthrough below, you create
71-
a more realistic Operation that reads Kubernetes Ingress resources and
71+
a more realistic `Operation` that reads Kubernetes `Ingress` resources and
7272
annotates them with certificate expiry information for monitoring tools.
7373

7474
## Prerequisites
@@ -91,17 +91,17 @@ helm upgrade --install crossplane crossplane-stable/crossplane \
9191

9292
## Create an operation
9393

94-
Follow these steps to create your first Operation:
94+
Follow these steps to create your first `Operation`:
9595

9696
1. [Create a sample Ingress](#create-a-sample-ingress) for certificate checking
9797
1. [Install the function](#install-the-function) you want to use for the
9898
operation
99-
1. [Create the Operation](#create-the-operation) that checks the Ingress
99+
1. [Create the Operation](#create-the-operation) that checks the `Ingress`
100100
1. [Check the Operation](#check-the-operation) as it runs
101101

102102
### Create a sample Ingress
103103

104-
Create an Ingress that references a real hostname but doesn't route actual
104+
Create an `Ingress` that references a real hostname but doesn't route actual
105105
traffic:
106106

107107
```yaml
@@ -132,8 +132,8 @@ kubectl apply -f ingress.yaml
132132

133133
### Grant Ingress permissions
134134

135-
Operations need permission to access and change Ingresses. Create a ClusterRole
136-
that grants Crossplane access to Ingresses:
135+
`Operations` need permission to access and change `Ingresses`. Create a `ClusterRole`
136+
that grants Crossplane access to `Ingresses`:
137137

138138
```yaml
139139
apiVersion: rbac.authorization.k8s.io/v1
@@ -186,7 +186,7 @@ crossplane-contrib-function-python True True xpkg.crossplane.io/cr
186186

187187
### Create the operation
188188

189-
Create this Operation that monitors the Ingress certificate:
189+
Create this `Operation` that monitors the `Ingress` certificate:
190190

191191
```yaml
192192
apiVersion: ops.crossplane.io/v1alpha1
@@ -275,7 +275,7 @@ kubectl apply -f operation.yaml
275275

276276
### Check the operation
277277

278-
Check that the Operation runs successfully:
278+
Check that the `Operation` runs successfully:
279279

280280
```shell {copy-lines="1"}
281281
kubectl get -f operation.yaml
@@ -284,10 +284,10 @@ ingress-cert-monitor True True 15s
284284
```
285285

286286
{{<hint "tip">}}
287-
Operations show `SUCCEEDED=True` when they complete successfully.
287+
`Operations` show `SUCCEEDED=True` when they complete successfully.
288288
{{</hint>}}
289289

290-
Check the Operation's detailed status:
290+
Check the `Operation`'s detailed status:
291291

292292
```shell {copy-lines="1"}
293293
kubectl describe operation ingress-cert-monitor
@@ -317,7 +317,7 @@ The `status.pipeline` field shows the output returned by each function step.
317317
Use this field for tracking what the operation accomplished.
318318
{{</hint>}}
319319

320-
Check that the Operation annotated the Ingress with certificate information:
320+
Check that the `Operation` annotated the `Ingress` with certificate information:
321321

322322
```shell {copy-lines="1"}
323323
kubectl get ingress example-app -o yaml
@@ -335,8 +335,8 @@ spec:
335335
```
336336

337337
{{<hint "tip">}}
338-
This pattern shows how Operations can both read and change existing Kubernetes
339-
resources. The Operation annotated the Ingress with certificate expiry
338+
This pattern shows how `Operations` can both read and change existing Kubernetes
339+
resources. The `Operation` annotated the `Ingress` with certificate expiry
340340
information that other tools can use for monitoring and alerting.
341341
{{</hint>}}
342342

@@ -353,14 +353,14 @@ kubectl delete -f function.yaml
353353

354354
## Next steps
355355

356-
Operations are powerful building blocks for operational workflows. Learn more
356+
`Operations` are powerful building blocks for operational workflows. Learn more
357357
about:
358358

359-
* [**Operation concepts**]({{<ref "../operations/operation">}}) - Core
360-
Operation features and best practices
361-
* [**CronOperation**]({{<ref "../operations/cronoperation">}}) - Schedule
359+
* [**`Operation` concepts**]({{<ref "../operations/operation">}}) - Core
360+
`Operation` features and best practices
361+
* [**`CronOperation`**]({{<ref "../operations/cronoperation">}}) - Schedule
362362
operations to run automatically
363-
* [**WatchOperation**]({{<ref "../operations/watchoperation">}}) - Trigger
363+
* [**`WatchOperation`**]({{<ref "../operations/watchoperation">}}) - Trigger
364364
operations when resources change
365365

366366
Explore the complete [Operations documentation]({{<ref "../operations">}}) for

0 commit comments

Comments
 (0)