Openstack cloud workload migration tool
Project description
CloudFerry
==========
# Overview
CloudFerry is a tool for resources and workloads migration between two
OpenStack clouds.
# Supported OpenStack Releases
- Grizzly
- Icehouse
- Juno
# Objects Supported for Migration
## Keystone
- Tenants
- User roles
## Neutron
- Networks
* Private
* Public
* Shared
- Subnets
- Ports
- Floating IPs
- Security groups
- Routers
- LBaaS objects
- Quotas
## Glance
- Images
## Cinder
- Volumes
- Quotas
## Nova
- VMs
- VM's ephemeral storage
- Flavors
- User quotas
- Tenant quotas
- Key pairs
# User documentation
End-user documentation is available in `docs` folder, to compile in HTML run:
```
sphinx-build docs/ sphinx-build
```
# Requirements
- Connection to source and destination clouds through external (public)
network from host with CloudFerry.
- Valid private ssh-key for both clouds which will be using by CloudFerry for
data transferring.
- Admin keystone access (typically admin access point lives on 35357 port).
- sudo/root access on compute and controller nodes.
- Openstack MySQL DB write access.
- Credentials of global cloud admin for both clouds.
- All the Python requirements are listed in requirements.txt.
# Installation
CloudFerry can be installed as docker container or it can be installed as a
python package by pip
## Installation with pip
```
pip install git+git://github.com/MirantisWorkloadMobility/CloudFerry.git
```
## Installation with docker
### Building the docker container
```
docker build --build-arg cf_commit_or_branch=origin/master -t <username>/cf-in-docker .
```
### Start container
```
docker run -it <username>/cf-in-docker
```
### Saving and loading the container files
```
docker save --output=/path/to/save/CloudFerry.img <username>/cf-in-docker
docker load --input=/path/to/save/CloudFerry.img
```
# Usage
## Overview
CloudFerry tool is used by running python `cloudferry` executable from the
command line.
All available commands can be viewed with:
```
# see list of available commands
cloudferry list
```
## Configuration
Sample config can be generated with
```
oslo-config-generator --namespace cloudferry
```
Configuration process is quite complex and mostly manual try-and-see-if-works
process.
## Whole cloud migration
Make sure you have `migrate_whole_cloud` option in `migrate` section of config
is set to `True`.
Use `migrate` command with config file specified:
```
cloudferry migrate <config file>
```
## Migrating specific instances
In order to migrate specific VMs, one should use filters. This is done through
modifying filters file (`configs/filter.yaml` by default).
Edit `configs/filter.yaml`:
```
instances:
id:
- 7c53a6ab-0149-4232-80b3-b2d7ce02995a
- f0fea76a-0a7d-4c25-ab9e-f048dbc7365d
```
Run migration as usual:
```
cloudferry migrate configuration.ini --debug
```
## Playground
See QUICKSTART.md for the quickest way of running your first successful migration.
==========
# Overview
CloudFerry is a tool for resources and workloads migration between two
OpenStack clouds.
# Supported OpenStack Releases
- Grizzly
- Icehouse
- Juno
# Objects Supported for Migration
## Keystone
- Tenants
- User roles
## Neutron
- Networks
* Private
* Public
* Shared
- Subnets
- Ports
- Floating IPs
- Security groups
- Routers
- LBaaS objects
- Quotas
## Glance
- Images
## Cinder
- Volumes
- Quotas
## Nova
- VMs
- VM's ephemeral storage
- Flavors
- User quotas
- Tenant quotas
- Key pairs
# User documentation
End-user documentation is available in `docs` folder, to compile in HTML run:
```
sphinx-build docs/ sphinx-build
```
# Requirements
- Connection to source and destination clouds through external (public)
network from host with CloudFerry.
- Valid private ssh-key for both clouds which will be using by CloudFerry for
data transferring.
- Admin keystone access (typically admin access point lives on 35357 port).
- sudo/root access on compute and controller nodes.
- Openstack MySQL DB write access.
- Credentials of global cloud admin for both clouds.
- All the Python requirements are listed in requirements.txt.
# Installation
CloudFerry can be installed as docker container or it can be installed as a
python package by pip
## Installation with pip
```
pip install git+git://github.com/MirantisWorkloadMobility/CloudFerry.git
```
## Installation with docker
### Building the docker container
```
docker build --build-arg cf_commit_or_branch=origin/master -t <username>/cf-in-docker .
```
### Start container
```
docker run -it <username>/cf-in-docker
```
### Saving and loading the container files
```
docker save --output=/path/to/save/CloudFerry.img <username>/cf-in-docker
docker load --input=/path/to/save/CloudFerry.img
```
# Usage
## Overview
CloudFerry tool is used by running python `cloudferry` executable from the
command line.
All available commands can be viewed with:
```
# see list of available commands
cloudferry list
```
## Configuration
Sample config can be generated with
```
oslo-config-generator --namespace cloudferry
```
Configuration process is quite complex and mostly manual try-and-see-if-works
process.
## Whole cloud migration
Make sure you have `migrate_whole_cloud` option in `migrate` section of config
is set to `True`.
Use `migrate` command with config file specified:
```
cloudferry migrate <config file>
```
## Migrating specific instances
In order to migrate specific VMs, one should use filters. This is done through
modifying filters file (`configs/filter.yaml` by default).
Edit `configs/filter.yaml`:
```
instances:
id:
- 7c53a6ab-0149-4232-80b3-b2d7ce02995a
- f0fea76a-0a7d-4c25-ab9e-f048dbc7365d
```
Run migration as usual:
```
cloudferry migrate configuration.ini --debug
```
## Playground
See QUICKSTART.md for the quickest way of running your first successful migration.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
Built Distribution
CloudFerry-1.53.0-py2-none-any.whl
(335.1 kB
view hashes)
Close
Hashes for CloudFerry-1.53.0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbcf82871fccc597aade67521c0492043285a3558e2e9c486e1268eefb261c45 |
|
MD5 | aa5eb1bde8a2807a91426e7fe4d6d0b5 |
|
BLAKE2b-256 | ee84bd3d5bca5c620ca289b6ae7b052122524920eab2d0479725e63c4efa9c07 |