1"use strict";(self.webpackChunktigera_docs=self.webpackChunktigera_docs||[]).push([["2053"],{32155:function(e,t,o){o.r(t),o.d(t,{default:()=>h,frontMatter:()=>c,metadata:()=>n,assets:()=>a,toc:()=>s,contentTitle:()=>l});var n=JSON.parse('{"id":"reference/calicoctl/datastore/migrate/export","title":"calicoctl datastore migrate export","description":"Command and options for exporting an etcdv3 datastore.","source":"@site/calico_versioned_docs/version-3.27/reference/calicoctl/datastore/migrate/export.mdx","sourceDirName":"reference/calicoctl/datastore/migrate","slug":"/reference/calicoctl/datastore/migrate/export","permalink":"/calico/3.27/reference/calicoctl/datastore/migrate/export","draft":false,"unlisted":false,"editUrl":"https://github.com/tigera/docs/edit/main/calico_versioned_docs/version-3.27/reference/calicoctl/datastore/migrate/export.mdx","tags":[],"version":"3.27","frontMatter":{"description":"Command and options for exporting an etcdv3 datastore."},"sidebar":"calicoSidebar","previous":{"title":"calicoctl datastore migrate","permalink":"/calico/3.27/reference/calicoctl/datastore/migrate/overview"},"next":{"title":"calicoctl datastore migrate import","permalink":"/calico/3.27/reference/calicoctl/datastore/migrate/import"}}'),r=o("85893"),i=o("50065");let c={description:"Command and options for exporting an etcdv3 datastore."},l="calicoctl datastore migrate export",a={},s=[{value:"Display the help text for 'calicoctl datastore migrate export' command",id:"display-the-help-text-for-calicoctl-datastore-migrate-export-command",level:2},{value:"Exported resources",id:"exported-resources",level:3},{value:"Examples",id:"examples",level:3},{value:"General options",id:"general-options",level:3},{value:"See also",id:"see-also",level:2}];function d(e){let t={a:"a",code:"code",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",pre:"pre",ul:"ul",...(0,i.a)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"calicoctl-datastore-migrate-export",children:"calicoctl datastore migrate export"})}),"\n",(0,r.jsxs)(t.p,{children:["This sections describes the ",(0,r.jsx)(t.code,{children:"calicoctl datastore migrate export"})," command."]}),"\n",(0,r.jsxs)(t.p,{children:["Read the ",(0,r.jsx)(t.a,{href:"/calico/3.27/reference/calicoctl/overview",children:"calicoctl Overview"}),"\nfor a full list of calicoctl commands."]}),"\n",(0,r.jsx)(t.h2,{id:"display-the-help-text-for-calicoctl-datastore-migrate-export-command",children:"Display the help text for 'calicoctl datastore migrate export' command"}),"\n",(0,r.jsxs)(t.p,{children:["Run ",(0,r.jsx)(t.code,{children:"calicoctl datastore migrate export --help"})," to display the following help menu for the\ncommand."]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:"Usage:\n calicoctl datastore migrate export [--config=<CONFIG>]\n\nOptions:\n -h --help Show this screen.\n -c --config=<CONFIG> Path to the file containing connection\n configuration in YAML or JSON format.\n [default: /etc/calico/calicoctl.cfg]\n\nDescription:\n Export the contents of the etcdv3 datastore. Resources will be exported\n in yaml and json format. Save the results of this command to a file for\n later use with the import command.\n\n The resources exported include the following:\n - IPAMBlocks\n - BlockAffinities\n - IPAMHandles\n - IPAMConfigurations\n - IPPools\n - BGPConfigurations\n - BGPPeers\n - ClusterInformations\n - FelixConfigurations\n - GlobalNetworkPolicies\n - GlobalNetworkSets\n - HostEndpoints\n - KubeControllersConfigurations\n - NetworkPolicies\n - Networksets\n - Nodes\n\n The following resources are not exported:\n - WorkloadEndpoints\n - Profiles\n"})}),"\n",(0,r.jsx)(t.h3,{id:"exported-resources",children:"Exported resources"}),"\n",(0,r.jsxs)(t.p,{children:["The ",(0,r.jsx)(t.code,{children:"export"})," subcommand exports the following Calico resources:"]}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"IPAMBlocks"}),"\n",(0,r.jsx)(t.li,{children:"BlockAffinities"}),"\n",(0,r.jsx)(t.li,{children:"IPAMHandles"}),"\n",(0,r.jsx)(t.li,{children:"IPAMConfigurations"}),"\n",(0,r.jsx)(t.li,{children:"IPPools"}),"\n",(0,r.jsx)(t.li,{children:"BGPConfigurations"}),"\n",(0,r.jsx)(t.li,{children:"BGPPeers"}),"\n",(0,r.jsx)(t.li,{children:"ClusterInformations"}),"\n",(0,r.jsx)(t.li,{children:"FelixConfigurations"}),"\n",(0,r.jsx)(t.li,{children:"GlobalNetworkPolicies"}),"\n",(0,r.jsx)(t.li,{children:"GlobalNetworkSets"}),"\n",(0,r.jsx)(t.li,{children:"HostEndpoints"}),"\n",(0,r.jsx)(t.li,{children:"NetworkPolicies"}),"\n",(0,r.jsx)(t.li,{children:"Networksets"}),"\n",(0,r.jsx)(t.li,{children:"Nodes"}),"\n"]}),"\n",(0,r.jsxs)(t.p,{children:["The ",(0,r.jsx)(t.code,{children:"export"})," subcommand does not export the following resources\nsince they should be generated:"]}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:"WorkloadEndpoints"}),"\n",(0,r.jsx)(t.li,{children:"Profiles"}),"\n"]}),"\n",(0,r.jsx)(t.h3,{id:"examples",children:"Examples"}),"\n",(0,r.jsxs)(t.p,{children:["Export the contents of an etcdv3 datastore to a file named ",(0,r.jsx)(t.code,{children:"etcd-migration"}),"."]}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-bash",children:"calicoctl datastore migrate export > etcd-migration\n"})}
1),"\n",(0,r.jsx)(t.h3,{id:"general-options",children:"General options"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{children:"-c --config=<CONFIG> Path to the file containing connection\n configuration in YAML or JSON format.\n [default: /etc/calico/calicoctl.cfg]\n"})}),"\n",(0,r.jsx)(t.h2,{id:"see-also",children:"See also"}),"\n",(0,r.jsxs)(t.ul,{children:["\n",(0,r.jsx)(t.li,{children:(0,r.jsx)(t.a,{href:"/calico/3.27/operations/calicoctl/install",children:"Install calicoctl"})}),"\n",(0,r.jsxs)(t.li,{children:[(0,r.jsx)(t.a,{href:"/calico/3.27/reference/resources/overview",children:"Resources"})," for details on all valid resources, including file format\nand schema"]}),"\n"]})]})}function h(e={}){let{wrapper:t}={...(0,i.a)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(d,{...e})}):d(e)}},50065:function(e,t,o){o.d(t,{Z:function(){return l},a:function(){return c}});var n=o(67294);let r={},i=n.createContext(r);function c(e){let t=n.useContext(i);return n.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function l(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),n.createElement(i.Provider,{value:t},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.