Skip to content

Commit accd759

Browse files
authored
Merge pull request #20107 from n0npax/fix-restart-always-docs
Fix --restart=always docs
2 parents 7da5118 + 57d4d52 commit accd759

File tree

2 files changed

+6
-46
lines changed

2 files changed

+6
-46
lines changed

content/en/docs/reference/kubectl/conventions.md

Lines changed: 6 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ For a stable output in a script:
1717

1818
* Request one of the machine-oriented output forms, such as `-o name`, `-o json`, `-o yaml`, `-o go-template`, or `-o jsonpath`.
1919
* Fully-qualify the version. For example, `jobs.v1.batch/myjob`. This will ensure that kubectl does not use its default version that can change over time.
20-
* Specify the `--generator` flag to pin to a specific behavior when you use generator-based commands such as `kubectl run` or `kubectl expose`.
2120
* Don't rely on context, preferences, or other implicit states.
2221

2322
## Best Practices
@@ -27,11 +26,15 @@ For a stable output in a script:
2726
For `kubectl run` to satisfy infrastructure as code:
2827

2928
* Tag the image with a version-specific tag and don't move that tag to a new version. For example, use `:v1234`, `v1.2.3`, `r03062016-1-4`, rather than `:latest` (For more information, see [Best Practices for Configuration](/docs/concepts/configuration/overview/#container-images)).
30-
* Capture the parameters in a checked-in script, or at least use `--record` to annotate the created objects with the command line for an image that is lightly parameterized.
31-
* Pin to a specific [generator](#generators) version, such as `kubectl run --generator=run-pod/v1`.
3229
* Check in the script for an image that is heavily parameterized.
3330
* Switch to configuration files checked into source control for features that are needed, but not expressible via `kubectl run` flags.
3431

32+
You can use the `--dry-run` flag to preview the object that would be sent to your cluster, without really submitting it.
33+
34+
{{< note >}}
35+
All `kubectl` generators are deprecated. See the Kubernetes v1.17 documentation for a [list](https://v1-17.docs.kubernetes.io/docs/reference/kubectl/conventions/#generators) of generators and how they were used.
36+
{{< /note >}}
37+
3538
#### Generators
3639
You can generate the following resources with a kubectl command, `kubectl create --dry-run -o yaml`:
3740
```
@@ -52,43 +55,6 @@ You can generate the following resources with a kubectl command, `kubectl create
5255
serviceaccount Create a service account with the specified name.
5356
```
5457

55-
56-
You can create the following resources using `kubectl run` with the `--generator` flag:
57-
58-
{{< table caption="Resources you can create using kubectl run" >}}
59-
| Resource | API group | kubectl command |
60-
|--------------------------------------|--------------------|---------------------------------------------------|
61-
| Pod | v1 | `kubectl run --generator=run-pod/v1` |
62-
| ReplicationController _(deprecated)_ | v1 | `kubectl run --generator=run/v1` |
63-
| Deployment _(deprecated)_ | extensions/v1beta1 | `kubectl run --generator=deployment/v1beta1` |
64-
| Deployment _(deprecated)_ | apps/v1beta1 | `kubectl run --generator=deployment/apps.v1beta1` |
65-
| Job _(deprecated)_ | batch/v1 | `kubectl run --generator=job/v1` |
66-
| CronJob _(deprecated)_ | batch/v2alpha1 | `kubectl run --generator=cronjob/v2alpha1` |
67-
| CronJob _(deprecated)_ | batch/v1beta1 | `kubectl run --generator=cronjob/v1beta1` |
68-
{{< /table >}}
69-
70-
{{< note >}}
71-
Generators other than `run-pod/v1` are deprecated.
72-
{{< /note >}}
73-
74-
If you explicitly set `--generator`, kubectl uses the generator you specified. If you invoke `kubectl run` and don't specify a generator, kubectl automatically selects which generator to use based on the other flags you set. The following table lists flags and the generators that are activated if you didn't specify one yourself:
75-
76-
{{< table caption="kubectl run flags and the resource they imply" >}}
77-
| Flag | Generated Resource |
78-
|-------------------------|-----------------------|
79-
| `--schedule=<schedule>` | CronJob |
80-
| `--restart=Always` | Deployment |
81-
| `--restart=OnFailure` | Job |
82-
| `--restart=Never` | Pod |
83-
{{< /table >}}
84-
85-
If you don't specify a generator, kubectl pays attention to other flags in the following order:
86-
87-
1. `--schedule`
88-
1. `--restart`
89-
90-
You can use the `--dry-run` flag to preview the object that would be sent to your cluster, without really submitting it.
91-
9258
### `kubectl apply`
9359

9460
* You can use `kubectl apply` to create or update resources. For more information about using kubectl apply to update resources, see [Kubectl Book](https://kubectl.docs.kubernetes.io).

content/en/docs/tasks/job/automated-tasks-with-cron-jobs.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,6 @@ The output is similar to this:
4949
cronjob.batch/hello created
5050
```
5151

52-
Alternatively, you can use `kubectl run` to create a cron job without writing a full config:
53-
54-
```shell
55-
kubectl run hello --schedule="*/1 * * * *" --restart=OnFailure --image=busybox -- /bin/sh -c "date; echo Hello from the Kubernetes cluster"
56-
```
57-
5852
After creating the cron job, get its status using this command:
5953

6054
```shell

0 commit comments

Comments
 (0)