Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/int32bit/openstack-workflow

Openstack Sequence Diagrams(Openstack操作序列图)
https://github.com/int32bit/openstack-workflow

nova openstack

Last synced: 4 days ago
JSON representation

Openstack Sequence Diagrams(Openstack操作序列图)

Host: GitHub
URL: https://github.com/int32bit/openstack-workflow
Owner: int32bit
License: mit
Created: 2016-06-15T06:57:30.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2021-05-31T02:16:36.000Z (over 3 years ago)
Last Synced: 2024-08-02T20:48:32.940Z (3 months ago)
Topics: nova, openstack
Language: Python
Homepage: https://github.com/int32bit/openstack-workflow
Size: 6.54 MB
Stars: 497
Watchers: 60
Forks: 201
Open Issues: 5
Metadata Files:
- Readme: README.en.md
- License: LICENSE

Awesome Lists containing this project

README

        [👉中文版本](./README.zh.md)

# Openstack Sequence Diagrams

Draw Openstack operation sequence diagrams using [Websequence Diagrams Tool](https://www.websequencediagrams.com/). An easiest way to track the source of Openstack and can be useful for user to learn Openstack or administer to problem troubleshooting. Noted that all these works are based on Openstack Liberty version, it may be changed in the future version, be careful to use if your Openstack version is not Liberty.

## Action List

### 1. Virtual Machine Manager

- [x] [Boot](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/create.png)

- [x] [Start](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/start.png)

- [x] [Stop](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/stop.png)

- [x] [Reboot](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/reboot.png)

- [x] [Rebuild](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/rebuild.png)

- [x] [Resize](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/resize.png)

- [x] [List](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/list.png)

- [x] [Delete](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/delete.png)

- [x] [Reset State](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/reset_state.png)

- [x] [Create Image(Snapshot)](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/snapshot.png)

- [x] [Change Admin Password](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/changePassword.png)

- [x] [Evacuate](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/evacuate.png)

- [x] [Pause](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/pause.png)

- [x] [Unpause](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/unpause.png)

- [x] [Suspend](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/suspend.png)

- [x] [Resume](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/resume.png)

- [x] [Reset Network](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/reset_network.png)

- [x] [Cold Migrate](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/migrate.png)

- [x] [Live Migrate](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/live_migrate.png)

- [x] [Shelve](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/shelve.png)

- [x] [Shelve-offload](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/shelve_offload.png)

- [x] [Unshelve](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/unshelve.png)

- [x] [Lock](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/lock.png)

- [x] [Unlock](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/unlock.png)

- [x] [Backup](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/backup.png)

- [x] [Refresh Network](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/reset_network.png)

- [x] [Rename](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/rename.png)

- [x] [Rescue](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/rescue.png)

- [x] [Unrescue](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/unrescue.png)

- [x] [volume Attach](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/volume_attach.png)

- [x] [Volume Detach](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/volume-detach.png)

- [x] [Interface Attach](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/interface-attach.png)

- [x] [Interface Detach](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/nova/interface-detach.png)

### 2. Todo

- [ ] Cinder

- [ ] Neutron

- [ ] Sahara

    * - [x] [Create cluster](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/sahara/create_cluster.png)

![create cluster](https://raw.githubusercontent.com/int32bit/openstack-workflow/master/output/sahara/create_cluster.png)

- [ ] Magnum

- [ ] ...

## Quick Start

### 1. Generate diagrams

Before generate the diagrams on your localhost, ensure your machine can access the Internet and the `make` tools hava been correctly installed.

```

make

```

All diagrams generated will be placed in `./output` by default.

### 2. Remove diagrams

To cleanup the diagrams, just run this as follows:

```

make clean

```

## Some demo

### 1. Create Server Workflow

![create server workflow](output/nova/create.png)

### 2. Reboot Server

 

![reboot server](output/nova/reboot.png)

### 3. Stop Server

![stop server](output/nova/stop.png)

### 4. Rebuild Server

![rebuild server](output/nova/rebuild.png)

## Need more diagrams ?

DYI, as you need!

For example:

```

title pause a server

participant client

participant nova_api

client->nova_api: pause

activate client

activate nova_api

# nova/api/openstack/compute/pause_server.py _pause()

note over nova_api: authrize context

nova_api->database: get instance by uuid

database->nova_api: done

# nova/compute/api.py pause()

note over nova_api: check policy

note over nova_api: check instance lock

note over nova_api: check instance cell

note over nova_api: ensure instance state is ACTIVE

nova_api->database: task_state = PAUSING

database->nova_api: done

note over nova_api: record pause action

# nova/compute/rpcapi.py pause_instance()

nova_api->nova_compute: pause_instance

deactivate nova_api

deactivate client

activate nova_compute

# nova/compute/manager.py pause_instance()

note over nova_compute: notify: pause.start

nova_compute->libvirt: pause

activate libvirt

# nova/virt/libvirt/driver.py pause()

note over libvirt: get domain

note over libvirt: domain.suspend()

libvirt->nova_compute: done

deactivate libvirt

# nova/compute/manager.py pause_instance()

nova_compute->database: vm_state = vm_states.PAUSED\ntask_state = None

database->nova_compute: done

note over nova_compute: notify: pause.end

deactivate nova_compute

```

## Contributors

The following have contributed to this project:

* AndiaQ

* int32bit

* ljjjustin

Many thanks for this! (If I have forgotten you, please let me know and put you in the list of fame. :-))

## License 

MIT