Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
description: Reference for the calicoctl datastore migrate-policy-names command in Calico Open Source, used to fix pre-v3.32 policy names on an upgraded etcdv3 datastore.
---

# calicoctl datastore migrate-policy-names

This section describes the `calicoctl datastore migrate-policy-names` command.

Read the [calicoctl Overview](../overview.mdx)
for a full list of calicoctl commands.

:::note

This command is available in Calico v3.32.2 and later. You only need it on an
etcdv3 datastore (for example, OpenStack) that was created before v3.32 and
upgraded in place. A Kubernetes datastore is migrated automatically by
kube-controllers, so no manual step is required there.

:::

## Display the help text for 'calicoctl datastore migrate-policy-names' command

Run `calicoctl datastore migrate-policy-names --help` to display the following help menu for the
command.

```
Usage:
calicoctl datastore migrate-policy-names [--config=<CONFIG>] [--allow-version-mismatch]

Options:
-h --help Show this screen.
-c --config=<CONFIG> Path to the file containing connection
configuration in YAML or JSON format.
[default: /etc/calico/calicoctl.cfg]
--allow-version-mismatch Allow client and cluster versions mismatch.

Description:
Rewrite policy names in the datastore to drop the legacy "default." tier
prefix, aligning the stored name with the v3 resource name introduced in
v3.32.

This is only needed for an etcdv3 datastore (for example OpenStack) that was
created before v3.32 and upgraded in place. A Kubernetes datastore is
migrated automatically by kube-controllers. The command is safe to re-run.
```

### Examples

Rewrite any pre-v3.32 policy names in the datastore so they match their v3 names.

```bash
calicoctl datastore migrate-policy-names
```

On completion, the command reports how many policies it rewrote.

```
Policy name migration complete, migrated 5 policies.
```

The command is idempotent. Running it again once every policy has already been
migrated reports `migrated 0 policies` and makes no changes.

### General options

```
-c --config=<CONFIG> Path to the file containing connection
configuration in YAML or JSON format.
[default: /etc/calico/calicoctl.cfg]
```

## See also

- [Install calicoctl](../../../operations/calicoctl/install.mdx)
- [Upgrade Calico on OpenStack](../../../operations/upgrading/openstack-upgrade.mdx) for the full upgrade procedure that runs this command
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,17 @@ This section describes the `calicoctl datastore` commands.
Read the [calicoctl Overview](../overview.mdx)
for a full list of calicoctl commands.

## Display the help text for 'calicoctl datastore migrate' commands
## Display the help text for 'calicoctl datastore' commands

Run `calicoctl datastore migrate --help` to display the following help menu for the
Run `calicoctl datastore --help` to display the following help menu for the
commands.

```
Usage:
calicoctl datastore <command> [<args>...]

migrate Migrate the contents of an etcdv3 datastore to a Kubernetes datastore.
migrate Migrate the contents of an etcdv3 datastore to a Kubernetes datastore.
migrate-policy-names Rewrite pre-v3.32 policy names in an etcdv3 datastore to drop the legacy "default." tier prefix.

Options:
-h --help Show this screen.
Expand All @@ -35,3 +36,4 @@ Details on the `calicoctl datastore` commands are described in the documents lin
organized by sub command.

- [calicoctl datastore migrate](migrate/overview.mdx)
- [calicoctl datastore migrate-policy-names](migrate-policy-names.mdx)
3 changes: 2 additions & 1 deletion calico_versioned_sidebars/version-3.32-sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -685,7 +685,8 @@
"reference/calicoctl/datastore/migrate/lock",
"reference/calicoctl/datastore/migrate/unlock"
]
}
},
"reference/calicoctl/datastore/migrate-policy-names"
]
},
"reference/calicoctl/version"
Expand Down