Skip to content

Master/slave to Primary/secondary changes #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 18, 2023
Merged

Master/slave to Primary/secondary changes #59

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
124 changes: 58 additions & 66 deletions docs/georep.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,7 @@ Generate Geo-replication SSH Keys

## create
```python
create(volname,
slave_host,
slave_vol,
slave_user='root',
create(primary_volume, secondary_host, secondary_volume, secondary_user='root',
push_pem=True,
no_verify=False,
force=False,
Expand All @@ -28,12 +25,12 @@ create(volname,

Create Geo-replication Session

:param volname: Master Volume Name
:param slave_host: Slave Hostname or IP
:param slave_vol: Slave Volume
:param slave_user: Slave User, default is "root"
:param push_pem: True|False Push SSH keys to Slave
:param no_verify: True|False Skip the Slave Verification
:param primary_volume: Primary Volume Name
:param secondary_host: Secondary Hostname or IP
:param secondary_volume: Secondary Volume
:param secondary_user: Secondary User, default is "root"
:param push_pem: True|False Push SSH keys to Secondary
:param no_verify: True|False Skip the Secondary Verification
process before create
:param force: True|False Force Create Session
:param ssh_port: SSH Port, Default is 22
Expand All @@ -43,120 +40,115 @@ Create Geo-replication Session

## start
```python
start(volname, slave_host, slave_vol, slave_user='root', force=False)
start(primary_volume, secondary_host, secondary_volume, secondary_user='root', force=False)
```

Start Geo-replication Session

:param volname: Master Volume Name
:param slave_host: Slave Hostname or IP
:param slave_vol: Slave Volume
:param slave_user: Slave User, default is "root"
:param primary_volume: Primary Volume Name
:param secondary_host: Secondary Hostname or IP
:param secondary_volume: Secondary Volume
:param secondary_user: Secondary User, default is "root"
:param force: True|False Force Start the Session
:returns: Output of Start command, raises
GlusterCmdException((rc, out, err)) on error


## stop
```python
stop(volname, slave_host, slave_vol, slave_user='root', force=False)
stop(primary_volume, secondary_host, secondary_volume, secondary_user='root', force=False)
```

Stop Geo-replication Session

:param volname: Master Volume Name
:param slave_host: Slave Hostname or IP
:param slave_vol: Slave Volume
:param slave_user: Slave User, default is "root"
:param primary_volume: Primary Volume Name
:param secondary_host: Secondary Hostname or IP
:param secondary_volume: Secondary Volume
:param secondary_user: Secondary User, default is "root"
:param force: True|False Force Stop the Session
:returns: Output of Stop command, raises
GlusterCmdException((rc, out, err)) on error


## restart
```python
restart(volname, slave_host, slave_vol, slave_user='root', force=False)
restart(primary_volume, secondary_host, secondary_volume, secondary_user='root', force=False)
```

Restart Geo-replication Session

:param volname: Master Volume Name
:param slave_host: Slave Hostname or IP
:param slave_vol: Slave Volume
:param slave_user: Slave User, default is "root"
:param primary_volume: Primary Volume Name
:param secondary_host: Secondary Hostname or IP
:param secondary_volume: Secondary Volume
:param secondary_user: Secondary User, default is "root"
:param force: True|False Force Start the Session
:returns: Output of Start command, raises
GlusterCmdException((rc, out, err)) on error


## delete
```python
delete(volname,
slave_host,
slave_vol,
slave_user='root',
delete(primary_volume, secondary_host, secondary_volume, secondary_user='root',
reset_sync_time=None)
```

Delete Geo-replication Session

:param volname: Master Volume Name
:param slave_host: Slave Hostname or IP
:param slave_vol: Slave Volume
:param slave_user: Slave User, default is "root"
:param primary_volume: Primary Volume Name
:param secondary_host: Secondary Hostname or IP
:param secondary_volume: Secondary Volume
:param secondary_user: Secondary User, default is "root"
:param reset_sync_time: True|False Reset Sync time on delete
:returns: Output of Start command, raises
GlusterCmdException((rc, out, err)) on error


## pause
```python
pause(volname, slave_host, slave_vol, slave_user='root', force=False)
pause(primary_volume, secondary_host, secondary_volume, secondary_user='root', force=False)
```

Pause Geo-replication Session

:param volname: Master Volume Name
:param slave_host: Slave Hostname or IP
:param slave_vol: Slave Volume
:param slave_user: Slave User, default is "root"
:param primary_volume: Primary Volume Name
:param secondary_host: Secondary Hostname or IP
:param secondary_volume: Secondary Volume
:param secondary_user: Secondary User, default is "root"
:param force: True|False Force Pause Session
:returns: Output of Pause command, raises
GlusterCmdException((rc, out, err)) on error


## resume
```python
resume(volname, slave_host, slave_vol, slave_user='root', force=False)
resume(primary_volume, secondary_host, secondary_volume, secondary_user='root', force=False)
```

Resume Geo-replication Session

:param volname: Master Volume Name
:param slave_host: Slave Hostname or IP
:param slave_vol: Slave Volume
:param slave_user: Slave User, default is "root"
:param primary_volume: Primary Volume Name
:param secondary_host: Secondary Hostname or IP
:param secondary_volume: Secondary Volume
:param secondary_user: Secondary User, default is "root"
:param force: True|False Force Resume Session
:returns: Output of Resume command, raises
GlusterCmdException((rc, out, err)) on error


## config_set
```python
config_set(volname,
slave_host,
slave_vol,
config_set(primary_volume, secondary_host, secondary_volume,
key,
value,
slave_user='root')
secondary_user='root')
```

Set Config of a Geo-replication Session

:param volname: Master Volume Name
:param slave_host: Slave Hostname or IP
:param slave_vol: Slave Volume
:param slave_user: Slave User, default is "root"
:param primary_volume: Primary Volume Name
:param secondary_host: Secondary Hostname or IP
:param secondary_volume: Secondary Volume
:param secondary_user: Secondary User, default is "root"
:param key: Config Key
:param value: Config Value
:returns: Output of Config set command, raises
Expand All @@ -165,47 +157,47 @@ Set Config of a Geo-replication Session

## config_reset
```python
config_reset(volname, slave_host, slave_vol, key, slave_user='root')
config_reset(primary_volume, secondary_host, secondary_volume, key, secondary_user='root')
```

Reset configuration of Geo-replication Session

:param volname: Master Volume Name
:param slave_host: Slave Hostname or IP
:param slave_vol: Slave Volume
:param slave_user: Slave User, default is "root"
:param primary_volume: Primary Volume Name
:param secondary_host: Secondary Hostname or IP
:param secondary_volume: Secondary Volume
:param secondary_user: Secondary User, default is "root"
:param key: Config Key
:returns: Output of Config reset command, raises
GlusterCmdException((rc, out, err)) on error


## config_get
```python
config_get(volname, slave_host, slave_vol, key=None, slave_user='root')
config_get(primary_volume, secondary_host, secondary_volume, key=None, secondary_user='root')
```

Get Configuration of Geo-replication Session

:param volname: Master Volume Name
:param slave_host: Slave Hostname or IP
:param slave_vol: Slave Volume
:param slave_user: Slave User, default is "root"
:param primary_volume: Primary Volume Name
:param secondary_host: Secondary Hostname or IP
:param secondary_volume: Secondary Volume
:param secondary_user: Secondary User, default is "root"
:param key: Config Key
:returns: Geo-rep session Config Values, raises
GlusterCmdException((rc, out, err)) on error


## status
```python
status(volname=None, slave_host=None, slave_vol=None, slave_user='root')
status(primary_volume=None, secondary_host=None, secondary_volume=None, secondary_user='root')
```

Status of Geo-replication Session

:param volname: Master Volume Name
:param slave_host: Slave Hostname or IP
:param slave_vol: Slave Volume
:param slave_user: Slave User, default is "root"
:param primary_volume: Primary Volume Name
:param secondary_host: Secondary Hostname or IP
:param secondary_volume: Secondary Volume
:param secondary_user: Secondary User, default is "root"
:returns: Geo-replication Status, raises
GlusterCmdException((rc, out, err)) on error

Loading