Kubectl Export is deprecated . Any alternative

Question

I'm looking for a way to export a yaml file from a deployed component but without the cluster specific information.

kubectl get MYOBJECT --export -o yaml > my.yaml

but since "export" is now deprecated (since 1.14 and should normally disappear in 1.18 (didn't find it in changelog), what would be an alternative ?

thanks

`kubectl get ... -o yaml | kubectl neat` – guettli Feb 03 '22 at 21:00 — guettli, Feb 03 '22 at 21:00

score 14 · Answer 1 · edited Nov 25 '20 at 12:33

14

Using JQ does the trick.

kubectl get secret <secretname> -ojson | jq 'del(.metadata.namespace,.metadata.resourceVersion,.metadata.uid) | .metadata.creationTimestamp=null'

produces exactly the same JSON as

kubectl get secret <secretname> -ojson --export

edited Nov 25 '20 at 12:33

Shane Bishop

3,905
4
17
47

answered May 25 '20 at 12:59

adel-s

137
1
6

1

here example with more cleanup and change name. `kubectl get secret my-source-secret -n -my-source-ns -ojson | jq 'del(.metadata.namespace,.metadata.resourceVersion,.metadata.uid,.metadata.selfLink,.metadata.managedFields,.metadata.annotations."kubectl.kubernetes.io/last-applied-configuration") | .metadata.creationTimestamp=null | .metadata.name="my-new-secret-name"' | kubectl apply -n target-ns -f -` – Tilo Sep 16 '21 at 17:24

score 11 · Answer 2 · answered Jun 06 '20 at 10:59

11

If you want to use YAML input / output, you can use yq.

This did the trick for me, add or remove filters as appropriate for you:

kubectl get secret "my_secret" -n "my_namespace" --context "my_context" -o yaml \
    | yq d - 'metadata.resourceVersion' \
    | yq d - 'metadata.uid' \
    | yq d - 'metadata.annotations' \
    | yq d - 'metadata.creationTimestamp' \
    | yq d - 'metadata.selfLink'

answered Jun 06 '20 at 10:59

Erik Živković

4,867
2
35
53

might as well delete the entire metadata and do a write of a new value – Sa'ad Sep 30 '20 at 06:56
1

add this line : ``` | yq d - 'metadata.managedFields' ``` – Serge Hartmann Nov 10 '20 at 15:47
3

If you are like me and got yq 4 the new syntax is as follows: kubectl get secret "my_secret" --namespace="my_namespace" -o yaml \ | yq e 'del(.metadata.resourceVersion)' - \ | yq e 'del(.metadata.uid)' - \ | yq e 'del(.metadata.annotations)' - \ | yq e 'del(.metadata.creationTimestamp)' - \ | yq e 'del(.metadata.selfLink)' - \ | yq e 'del(.metadata.managedFields)' - \ – Conor Apr 23 '21 at 18:37

score 11 · Answer 3 · answered Feb 20 '21 at 17:42

11

Finally an easy to use tool has been created: https://github.com/itaysk/kubectl-neat

You could easily install all it as a kubectl krew plugin:

kubectl krew install neat

Usage as well is pretty simple

kubectl get pod mypod -o yaml | kubectl neat

answered Feb 20 '21 at 17:42

toschneck

770
7
12

2

oh man, kubectl-neat is aptly named. it's super neat. makes a HUGE difference when updating IAC. thanks for adding that link! – ingernet Feb 24 '21 at 20:11
except I do not see `status` key. – Ciasto piekarz Mar 06 '21 at 21:37
Works as it should. The purpose is to show the manifest without runtime state. – demonkoryu May 02 '22 at 22:37

score 9 · Accepted Answer · answered Apr 23 '20 at 16:30

9

There is no consistent way to do this since there is no overall guidelines about defaulting and other live data clean up. That is why it was deprecated. You should keep your source files in git or similar.

answered Apr 23 '20 at 16:30

coderanger

52,400
4
52
75

score 7 · Answer 5 · answered Apr 23 '20 at 22:00

7

Currently the one option is to do -o yaml or -o json and remove the unnecessary fields

answered Apr 23 '20 at 22:00

hoque

5,735
1
19
29

1

Indeed doing `kubectl get MYOBJECT -o yaml > my.yaml` instead of `kubectl get MYOBJECT --export -o yaml > my.yaml` seems to produce almost the same output except for a few additional fields which should not do any harm. – finrod Jun 22 '20 at 09:53

Marcelo · Answer 6 · 2020-06-22T20:10:52.387

5

Another option is to make use of the annotation field kubectl.kubernetes.io/last-applied-configuration which holds the resource initial applied configuraiton without auto-generated fields.

Example:

kubectl get <resource kind> <resource name> -o yaml | \
yq r - 'metadata.annotations."kubectl.kubernetes.io/last-applied-configuration"'

edited Jun 22 '20 at 20:10

answered Jun 22 '20 at 14:34

Marcelo

2,245
4
20
24

I get `Error: unknown command "r" for "yq"`. I think you meant `yq e`? – Prashanth Chandra Dec 09 '21 at 02:17
maybe we are using different yq versions, that's what I meant: https://mikefarah.gitbook.io/yq/v/v2.x/read – Marcelo Dec 10 '21 at 12:09

score 4 · Answer 7 · answered Feb 15 '21 at 15:07

4

For anyone using yq v4.x you can do the following to get what you need:

kubectl get <resource> -n <namespace> <resource-name> -o yaml \
  | yq eval 'del(.metadata.resourceVersion, .metadata.uid, .metadata.annotations, .metadata.creationTimestamp, .metadata.selfLink, .metadata.managedFields)' -

answered Feb 15 '21 at 15:07

Grant

811
1
8
18

this is the real neat (y) – Ciasto piekarz Mar 06 '21 at 21:39
That works like a charm. One field is missing `.metadata.generation` – Charles Moulliard Feb 08 '22 at 09:41

score 0 · Answer 8 · answered Oct 23 '20 at 22:19

0

Based on the above input, I created a short at our fubectl project: https://github.com/kubermatic/fubectl/pull/58

hopefully it helps also for others:

kget-ex RESOURCE > export.yaml

answered Oct 23 '20 at 22:19

toschneck

770
7
12

score 0 · Answer 9 · answered Nov 24 '21 at 09:09

0

Export is deprecated in latest version of Kube or Openshift. We can directly do it like below

 oc get virtualservices -o yaml > project.yaml
 oc get routes -o yaml > project.yaml

answered Nov 24 '21 at 09:09

Nilesh Kumar

109
1
5

2

The second line would overwrite the output of the first line. – guettli Feb 03 '22 at 20:26

score 0 · Answer 10 · answered Sep 20 '22 at 22:38

0

solution with ZERO dependencies to any 3rd-party tool:

kubectl -n $ns get [resourcetype] [resourcename] |\
 sed '/^  uid: /d; /^  resourceVersion: /d; /^  creationTimestamp: /d; /^  selfLink: /d; /^status:$/Q;'

Note: Works only with individual resources

answered Sep 20 '22 at 22:38

Abdennour TOUMI

87,526
38
249
254

score -2 · Answer 11 · answered Oct 18 '22 at 18:12

-2

Use yq to fetch the "last-applied-configuration" field (json format), then convert it to yaml.

 kbprod get deploy xxx -o yaml | yq e '.metadata.annotations."kubectl.kubernetes.io/last-applied-configuration"' | yq -p json -o yaml

answered Oct 18 '22 at 18:12

acala

332
3
11

Kubectl Export is deprecated . Any alternative

11 Answers11

Note: Works only with individual resources

Linked