RATIS-1860. Add ratis-shell cmd to generate a new raft-meta.conf.#901

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
codings-dan merged 11 commits into from
Aug 21, 2023
Merged

RATIS-1860. Add ratis-shell cmd to generate a new raft-meta.conf. #901

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
672d5f9
Add ratis-shell cmd to generate a new raft-meta.conf.
chunxiaozheng Aug 10, 2023
9b13aae
Remove index option.
chunxiaozheng Aug 15, 2023
8a5556d
Style fix.
chunxiaozheng Aug 15, 2023
24b7d1f
Use GroupCommand as the parent of RaftMetaConfCommand.
chunxiaozheng Aug 16, 2023
74ca5ae
Modified by review comments.
chunxiaozheng Aug 16, 2023
f3c9be2
Update cli.md
chunxiaozheng Aug 16, 2023
1d56bcc
Use LocalCommand as the parent of RaftMetaConfCommand.
chunxiaozheng Aug 18, 2023
7237234
ReConstruct some abstract command.
chunxiaozheng Aug 18, 2023
cb6398a
Modified by review comments.
chunxiaozheng Aug 20, 2023
fece8fb
Use println instead of printf.
chunxiaozheng Aug 20, 2023
f645ea8
Checkstyle error fix(delete some unuse import).
chunxiaozheng Aug 21, 2023
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
12 changes: 12 additions & 0 deletions ratis-docs/src/site/markdown/cli.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,7 @@ Usage: ratis sh [generic options]
[group [info] [list]]
[peer [add] [remove] [setPriority]]
[snapshot [create]]
[local [raftMetaConf]]
```

## generic options
Expand DownExpand Up@@ -172,3 +173,14 @@ Trigger the specified server take snapshot.
```
$ ratis sh snapshot create -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -peerId <peerId0> [-groupid <RAFT_GROUP_ID>]
```

## local
The `local` command is used to process local operation, which no need to connect to ratis server.
It has the following subcommands:
`raftMetaConf`

### local raftMetaConf
Generate a new raft-meta.conf file based on original raft-meta.conf and new peers, which is used to move a raft node to a new node.
```
$ ratis sh local raftMetaConf -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -path <PARENT_PATH_OF_RAFT_META_CONF>
```
59 changes: 59 additions & 0 deletions ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractCommand.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;

import java.io.PrintStream;
import java.net.InetSocketAddress;

/**
* The base class for all the ratis shell {@link Command} classes.
*/
public abstract class AbstractCommand implements Command {

private final PrintStream printStream;

protected AbstractCommand(Context context) {
printStream = context.getPrintStream();
}

public static InetSocketAddress parseInetSocketAddress(String address) {
try {
final String[] hostPortPair = address.split(":");
if (hostPortPair.length < 2) {
throw new IllegalArgumentException("Unexpected address format <HOST:PORT>.");
}
return new InetSocketAddress(hostPortPair[0], Integer.parseInt(hostPortPair[1]));
} catch (Exception e) {
throw new IllegalArgumentException("Failed to parse the server address parameter \"" + address + "\".", e);
}
}

protected PrintStream getPrintStream() {
return printStream;
}

protected void printf(String format, Object... args) {
printStream.printf(format, args);
}

protected void println(Object message) {
printStream.println(message);
}
}
5 changes: 2 additions & 3 deletions ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractParentCommand.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -26,11 +26,10 @@
import java.util.function.Function;
import java.util.stream.Collectors;

public abstract class AbstractParentCommand extends AbstractRatisCommand{
public abstract class AbstractParentCommand implements Command {
private final Map<String, Command> subs;

public AbstractParentCommand(Context context, List<Function<Context, AbstractRatisCommand>> subCommandConstructors) {
super(context);
public AbstractParentCommand(Context context, List<Function<Context, Command>> subCommandConstructors) {
this.subs = Collections.unmodifiableMap(subCommandConstructors.stream()
.map(constructor -> constructor.apply(context))
.collect(Collectors.toMap(Command::getCommandName, Function.identity(),
Expand Down
33 changes: 3 additions & 30 deletions ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractRatisCommand.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,6 @@
import org.apache.commons.cli.Option;
import org.apache.ratis.protocol.*;
import org.apache.ratis.protocol.exceptions.RaftException;
import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.RaftUtils;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.Options;
Expand All@@ -34,7 +33,6 @@
import org.apache.ratis.util.function.CheckedFunction;

import java.io.IOException;
import java.io.PrintStream;
import java.net.InetSocketAddress;
import java.util.*;
import java.util.function.BiConsumer;
Expand All@@ -43,25 +41,13 @@
import java.util.stream.Stream;

/**
* The base class for all the ratis shell {@link Command} classes.
* The base class for the ratis shell which need to connect to server.
*/
public abstract class AbstractRatisCommand implements Command {
public abstract class AbstractRatisCommand extends AbstractCommand {
public static final String PEER_OPTION_NAME = "peers";
public static final String GROUPID_OPTION_NAME = "groupid";
public static final RaftGroupId DEFAULT_RAFT_GROUP_ID = RaftGroupId.randomId();

public static InetSocketAddress parseInetSocketAddress(String address) {
try {
final String[] hostPortPair = address.split(":");
if (hostPortPair.length < 2) {
throw new IllegalArgumentException("Unexpected address format <HOST:PORT>.");
}
return new InetSocketAddress(hostPortPair[0], Integer.parseInt(hostPortPair[1]));
} catch (Exception e) {
throw new IllegalArgumentException("Failed to parse the server address parameter \"" + address + "\".", e);
}
}

/**
* Execute a given function with input parameter from the members of a list.
*
Expand All@@ -86,12 +72,11 @@ public static <T, K, E extends Throwable> K run(Collection<T> list, CheckedFunct
return null;
}

private final PrintStream printStream;
private RaftGroup raftGroup;
private GroupInfoReply groupInfoReply;

protected AbstractRatisCommand(Context context) {
printStream = context.getPrintStream();
super(context);
}

@Override
Expand DownExpand Up@@ -154,18 +139,6 @@ public Options getOptions() {
.addOption(GROUPID_OPTION_NAME, true, "Raft group id");
}

protected PrintStream getPrintStream() {
return printStream;
}

protected void printf(String format, Object... args) {
printStream.printf(format, args);
}

protected void println(Object message) {
printStream.println(message);
}

protected RaftGroup getRaftGroup() {
return raftGroup;
}
Expand Down
3 changes: 2 additions & 1 deletion ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/ElectionCommand.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
*/
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.election.PauseCommand;
import org.apache.ratis.shell.cli.sh.election.ResumeCommand;
import org.apache.ratis.shell.cli.sh.election.StepDownCommand;
Expand All@@ -28,7 +29,7 @@
import java.util.function.Function;

public class ElectionCommand extends AbstractParentCommand {
private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
= Collections.unmodifiableList(Arrays.asList(
TransferCommand::new, StepDownCommand::new, PauseCommand::new, ResumeCommand::new));

Expand Down
3 changes: 2 additions & 1 deletion ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/GroupCommand.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
*/
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.group.GroupInfoCommand;
import org.apache.ratis.shell.cli.sh.group.GroupListCommand;

Expand All@@ -30,7 +31,7 @@
*/
public class GroupCommand extends AbstractParentCommand {

private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
= Collections.unmodifiableList(Arrays.asList(
GroupInfoCommand::new, GroupListCommand::new));
/**
Expand Down
60 changes: 60 additions & 0 deletions ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/LocalCommand.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.local.RaftMetaConfCommand;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.function.Function;

/**
* Command for local operation, which no need to connect to ratis server
*/
public class LocalCommand extends AbstractParentCommand {

private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
= Collections.unmodifiableList(Arrays.asList(RaftMetaConfCommand::new));

/**
* @param context command context
*/
public LocalCommand(Context context) {
super(context, SUB_COMMAND_CONSTRUCTORS);
}

@Override
public String getCommandName() {
return "local";
}

@Override
public String getDescription() {
return description();
}

/**
* @return command's description
*/
public static String description() {
return "Command for local operation, which no need to connect to ratis server; "
+ "see the sub-commands for the details.";
}
}
3 changes: 2 additions & 1 deletion ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/PeerCommand.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
*/
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.peer.AddCommand;
import org.apache.ratis.shell.cli.sh.peer.RemoveCommand;
import org.apache.ratis.shell.cli.sh.peer.SetPriorityCommand;
Expand All@@ -31,7 +32,7 @@
*/
public class PeerCommand extends AbstractParentCommand{

private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
= Collections.unmodifiableList(Arrays.asList(AddCommand::new, RemoveCommand::new,
SetPriorityCommand::new));

Expand Down
3 changes: 2 additions & 1 deletion ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/SnapshotCommand.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
*/
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.snapshot.TakeSnapshotCommand;

import java.util.Arrays;
Expand All@@ -28,7 +29,7 @@
* Command for the ratis snapshot
*/
public class SnapshotCommand extends AbstractParentCommand {
private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
= Collections.unmodifiableList(Arrays.asList(TakeSnapshotCommand::new));

/**
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
RATIS-1860. Add ratis-shell cmd to generate a new raft-meta.conf.#901

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

codings-dan
merged 11 commits into

from

Aug 21, 2023
 Merged


RATIS-1860. Add ratis-shell cmd to generate a new raft-meta.conf.
#901
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
672d5f9

Add ratis-shell cmd to generate a new raft-meta.conf.


chunxiaozheng Aug 10, 2023
9b13aae

Remove index option.


chunxiaozheng Aug 15, 2023
8a5556d

Style fix.


chunxiaozheng Aug 15, 2023
24b7d1f

Use GroupCommand as the parent of RaftMetaConfCommand.


chunxiaozheng Aug 16, 2023
74ca5ae

Modified by review comments.


chunxiaozheng Aug 16, 2023
f3c9be2

Update cli.md


chunxiaozheng Aug 16, 2023
1d56bcc

Use LocalCommand as the parent of RaftMetaConfCommand.


chunxiaozheng Aug 18, 2023
7237234

ReConstruct some abstract command.


chunxiaozheng Aug 18, 2023
cb6398a

Modified by review comments.


chunxiaozheng Aug 20, 2023
fece8fb

Use println instead of printf.


chunxiaozheng Aug 20, 2023
f645ea8

Checkstyle error fix(delete some unuse import).


chunxiaozheng Aug 21, 2023

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


12 changes: 12 additions & 0 deletions
ratis-docs/src/site/markdown/cli.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,7 @@ Usage: ratis sh [generic options]
 [group [info] [list]]
 [peer [add] [remove] [setPriority]]
 [snapshot [create]]
 [local [raftMetaConf]]
```

## generic options
Expand DownExpand Up@@ -172,3 +173,14 @@ Trigger the specified server take snapshot.
```
$ ratis sh snapshot create -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -peerId <peerId0> [-groupid <RAFT_GROUP_ID>]
```

## local
The `local` command is used to process local operation, which no need to connect to ratis server.
It has the following subcommands:
`raftMetaConf`

### local raftMetaConf
Generate a new raft-meta.conf file based on original raft-meta.conf and new peers, which is used to move a raft node to a new node.
```
$ ratis sh local raftMetaConf -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -path <PARENT_PATH_OF_RAFT_META_CONF>
```

59 changes: 59 additions & 0 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;

import java.io.PrintStream;
import java.net.InetSocketAddress;

/**
 * The base class for all the ratis shell {@link Command} classes.
 */
public abstract class AbstractCommand implements Command {

 private final PrintStream printStream;

 protected AbstractCommand(Context context) {
 printStream = context.getPrintStream();
 }

 public static InetSocketAddress parseInetSocketAddress(String address) {
 try {
 final String[] hostPortPair = address.split(":");
 if (hostPortPair.length < 2) {
 throw new IllegalArgumentException("Unexpected address format <HOST:PORT>.");
 }
 return new InetSocketAddress(hostPortPair[0], Integer.parseInt(hostPortPair[1]));
 } catch (Exception e) {
 throw new IllegalArgumentException("Failed to parse the server address parameter \"" + address + "\".", e);
 }
 }

 protected PrintStream getPrintStream() {
 return printStream;
 }

 protected void printf(String format, Object... args) {
 printStream.printf(format, args);
 }

 protected void println(Object message) {
 printStream.println(message);
 }
}

5 changes: 2 additions & 3 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractParentCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,11 +26,10 @@
import java.util.function.Function;
import java.util.stream.Collectors;

public abstract class AbstractParentCommand extends AbstractRatisCommand{
public abstract class AbstractParentCommand implements Command {
 private final Map<String, Command> subs;

 public AbstractParentCommand(Context context, List<Function<Context, AbstractRatisCommand>> subCommandConstructors) {
 super(context);
 public AbstractParentCommand(Context context, List<Function<Context, Command>> subCommandConstructors) {
 this.subs = Collections.unmodifiableMap(subCommandConstructors.stream()
 .map(constructor -> constructor.apply(context))
 .collect(Collectors.toMap(Command::getCommandName, Function.identity(),
Expand Down

33 changes: 3 additions & 30 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractRatisCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,6 @@
import org.apache.commons.cli.Option;
import org.apache.ratis.protocol.*;
import org.apache.ratis.protocol.exceptions.RaftException;
import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.RaftUtils;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.Options;
Expand All@@ -34,7 +33,6 @@
import org.apache.ratis.util.function.CheckedFunction;

import java.io.IOException;
import java.io.PrintStream;
import java.net.InetSocketAddress;
import java.util.*;
import java.util.function.BiConsumer;
Expand All@@ -43,25 +41,13 @@
import java.util.stream.Stream;

/**
 * The base class for all the ratis shell {@link Command} classes.
 * The base class for the ratis shell which need to connect to server.
 */
public abstract class AbstractRatisCommand implements Command {
public abstract class AbstractRatisCommand extends AbstractCommand {
 public static final String PEER_OPTION_NAME = "peers";
 public static final String GROUPID_OPTION_NAME = "groupid";
 public static final RaftGroupId DEFAULT_RAFT_GROUP_ID = RaftGroupId.randomId();

 public static InetSocketAddress parseInetSocketAddress(String address) {
 try {
 final String[] hostPortPair = address.split(":");
 if (hostPortPair.length < 2) {
 throw new IllegalArgumentException("Unexpected address format <HOST:PORT>.");
 }
 return new InetSocketAddress(hostPortPair[0], Integer.parseInt(hostPortPair[1]));
 } catch (Exception e) {
 throw new IllegalArgumentException("Failed to parse the server address parameter \"" + address + "\".", e);
 }
 }

 /**
 * Execute a given function with input parameter from the members of a list.
 *
Expand All@@ -86,12 +72,11 @@ public static <T, K, E extends Throwable> K run(Collection<T> list, CheckedFunct
 return null;
 }

 private final PrintStream printStream;
 private RaftGroup raftGroup;
 private GroupInfoReply groupInfoReply;

 protected AbstractRatisCommand(Context context) {
printStream = context.getPrintStream();
super(context);
 }

 @Override
Expand DownExpand Up@@ -154,18 +139,6 @@ public Options getOptions() {
 .addOption(GROUPID_OPTION_NAME, true, "Raft group id");
 }

 protected PrintStream getPrintStream() {
 return printStream;
 }

 protected void printf(String format, Object... args) {
 printStream.printf(format, args);
 }

 protected void println(Object message) {
 printStream.println(message);
 }

 protected RaftGroup getRaftGroup() {
 return raftGroup;
 }
Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/ElectionCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.election.PauseCommand;
import org.apache.ratis.shell.cli.sh.election.ResumeCommand;
import org.apache.ratis.shell.cli.sh.election.StepDownCommand;
Expand All@@ -28,7 +29,7 @@
import java.util.function.Function;

public class ElectionCommand extends AbstractParentCommand {
 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(
 TransferCommand::new, StepDownCommand::new, PauseCommand::new, ResumeCommand::new));

Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/GroupCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.group.GroupInfoCommand;
import org.apache.ratis.shell.cli.sh.group.GroupListCommand;

Expand All@@ -30,7 +31,7 @@
 */
public class GroupCommand extends AbstractParentCommand {

 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(
 GroupInfoCommand::new, GroupListCommand::new));
 /**
Expand Down

60 changes: 60 additions & 0 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/LocalCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.local.RaftMetaConfCommand;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.function.Function;

/**
 * Command for local operation, which no need to connect to ratis server
 */
public class LocalCommand extends AbstractParentCommand {

 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(RaftMetaConfCommand::new));

 /**
 * @param context command context
 */
 public LocalCommand(Context context) {
 super(context, SUB_COMMAND_CONSTRUCTORS);
 }

 @Override
 public String getCommandName() {
 return "local";
 }

 @Override
 public String getDescription() {
 return description();
 }

 /**
 * @return command's description
 */
 public static String description() {
 return "Command for local operation, which no need to connect to ratis server; "
 + "see the sub-commands for the details.";
 }
}

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/PeerCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.peer.AddCommand;
import org.apache.ratis.shell.cli.sh.peer.RemoveCommand;
import org.apache.ratis.shell.cli.sh.peer.SetPriorityCommand;
Expand All@@ -31,7 +32,7 @@
 */
public class PeerCommand extends AbstractParentCommand{

 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(AddCommand::new, RemoveCommand::new,
 SetPriorityCommand::new));

Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/SnapshotCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.snapshot.TakeSnapshotCommand;

import java.util.Arrays;
Expand All@@ -28,7 +29,7 @@
 * Command for the ratis snapshot
 */
public class SnapshotCommand extends AbstractParentCommand {
 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(TakeSnapshotCommand::new));

 /**
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
RATIS-1860. Add ratis-shell cmd to generate a new raft-meta.conf.#901

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

codings-dan
merged 11 commits into

from

Aug 21, 2023
 Merged


RATIS-1860. Add ratis-shell cmd to generate a new raft-meta.conf.
#901
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
672d5f9

Add ratis-shell cmd to generate a new raft-meta.conf.


chunxiaozheng Aug 10, 2023
9b13aae

Remove index option.


chunxiaozheng Aug 15, 2023
8a5556d

Style fix.


chunxiaozheng Aug 15, 2023
24b7d1f

Use GroupCommand as the parent of RaftMetaConfCommand.


chunxiaozheng Aug 16, 2023
74ca5ae

Modified by review comments.


chunxiaozheng Aug 16, 2023
f3c9be2

Update cli.md


chunxiaozheng Aug 16, 2023
1d56bcc

Use LocalCommand as the parent of RaftMetaConfCommand.


chunxiaozheng Aug 18, 2023
7237234

ReConstruct some abstract command.


chunxiaozheng Aug 18, 2023
cb6398a

Modified by review comments.


chunxiaozheng Aug 20, 2023
fece8fb

Use println instead of printf.


chunxiaozheng Aug 20, 2023
f645ea8

Checkstyle error fix(delete some unuse import).


chunxiaozheng Aug 21, 2023

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


12 changes: 12 additions & 0 deletions
ratis-docs/src/site/markdown/cli.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,7 @@ Usage: ratis sh [generic options]
 [group [info] [list]]
 [peer [add] [remove] [setPriority]]
 [snapshot [create]]
 [local [raftMetaConf]]
```

## generic options
Expand DownExpand Up@@ -172,3 +173,14 @@ Trigger the specified server take snapshot.
```
$ ratis sh snapshot create -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -peerId <peerId0> [-groupid <RAFT_GROUP_ID>]
```

## local
The `local` command is used to process local operation, which no need to connect to ratis server.
It has the following subcommands:
`raftMetaConf`

### local raftMetaConf
Generate a new raft-meta.conf file based on original raft-meta.conf and new peers, which is used to move a raft node to a new node.
```
$ ratis sh local raftMetaConf -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -path <PARENT_PATH_OF_RAFT_META_CONF>
```

59 changes: 59 additions & 0 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;

import java.io.PrintStream;
import java.net.InetSocketAddress;

/**
 * The base class for all the ratis shell {@link Command} classes.
 */
public abstract class AbstractCommand implements Command {

 private final PrintStream printStream;

 protected AbstractCommand(Context context) {
 printStream = context.getPrintStream();
 }

 public static InetSocketAddress parseInetSocketAddress(String address) {
 try {
 final String[] hostPortPair = address.split(":");
 if (hostPortPair.length < 2) {
 throw new IllegalArgumentException("Unexpected address format <HOST:PORT>.");
 }
 return new InetSocketAddress(hostPortPair[0], Integer.parseInt(hostPortPair[1]));
 } catch (Exception e) {
 throw new IllegalArgumentException("Failed to parse the server address parameter \"" + address + "\".", e);
 }
 }

 protected PrintStream getPrintStream() {
 return printStream;
 }

 protected void printf(String format, Object... args) {
 printStream.printf(format, args);
 }

 protected void println(Object message) {
 printStream.println(message);
 }
}

5 changes: 2 additions & 3 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractParentCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,11 +26,10 @@
import java.util.function.Function;
import java.util.stream.Collectors;

public abstract class AbstractParentCommand extends AbstractRatisCommand{
public abstract class AbstractParentCommand implements Command {
 private final Map<String, Command> subs;

 public AbstractParentCommand(Context context, List<Function<Context, AbstractRatisCommand>> subCommandConstructors) {
 super(context);
 public AbstractParentCommand(Context context, List<Function<Context, Command>> subCommandConstructors) {
 this.subs = Collections.unmodifiableMap(subCommandConstructors.stream()
 .map(constructor -> constructor.apply(context))
 .collect(Collectors.toMap(Command::getCommandName, Function.identity(),
Expand Down

33 changes: 3 additions & 30 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractRatisCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,6 @@
import org.apache.commons.cli.Option;
import org.apache.ratis.protocol.*;
import org.apache.ratis.protocol.exceptions.RaftException;
import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.RaftUtils;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.Options;
Expand All@@ -34,7 +33,6 @@
import org.apache.ratis.util.function.CheckedFunction;

import java.io.IOException;
import java.io.PrintStream;
import java.net.InetSocketAddress;
import java.util.*;
import java.util.function.BiConsumer;
Expand All@@ -43,25 +41,13 @@
import java.util.stream.Stream;

/**
 * The base class for all the ratis shell {@link Command} classes.
 * The base class for the ratis shell which need to connect to server.
 */
public abstract class AbstractRatisCommand implements Command {
public abstract class AbstractRatisCommand extends AbstractCommand {
 public static final String PEER_OPTION_NAME = "peers";
 public static final String GROUPID_OPTION_NAME = "groupid";
 public static final RaftGroupId DEFAULT_RAFT_GROUP_ID = RaftGroupId.randomId();

 public static InetSocketAddress parseInetSocketAddress(String address) {
 try {
 final String[] hostPortPair = address.split(":");
 if (hostPortPair.length < 2) {
 throw new IllegalArgumentException("Unexpected address format <HOST:PORT>.");
 }
 return new InetSocketAddress(hostPortPair[0], Integer.parseInt(hostPortPair[1]));
 } catch (Exception e) {
 throw new IllegalArgumentException("Failed to parse the server address parameter \"" + address + "\".", e);
 }
 }

 /**
 * Execute a given function with input parameter from the members of a list.
 *
Expand All@@ -86,12 +72,11 @@ public static <T, K, E extends Throwable> K run(Collection<T> list, CheckedFunct
 return null;
 }

 private final PrintStream printStream;
 private RaftGroup raftGroup;
 private GroupInfoReply groupInfoReply;

 protected AbstractRatisCommand(Context context) {
printStream = context.getPrintStream();
super(context);
 }

 @Override
Expand DownExpand Up@@ -154,18 +139,6 @@ public Options getOptions() {
 .addOption(GROUPID_OPTION_NAME, true, "Raft group id");
 }

 protected PrintStream getPrintStream() {
 return printStream;
 }

 protected void printf(String format, Object... args) {
 printStream.printf(format, args);
 }

 protected void println(Object message) {
 printStream.println(message);
 }

 protected RaftGroup getRaftGroup() {
 return raftGroup;
 }
Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/ElectionCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.election.PauseCommand;
import org.apache.ratis.shell.cli.sh.election.ResumeCommand;
import org.apache.ratis.shell.cli.sh.election.StepDownCommand;
Expand All@@ -28,7 +29,7 @@
import java.util.function.Function;

public class ElectionCommand extends AbstractParentCommand {
 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(
 TransferCommand::new, StepDownCommand::new, PauseCommand::new, ResumeCommand::new));

Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/GroupCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.group.GroupInfoCommand;
import org.apache.ratis.shell.cli.sh.group.GroupListCommand;

Expand All@@ -30,7 +31,7 @@
 */
public class GroupCommand extends AbstractParentCommand {

 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(
 GroupInfoCommand::new, GroupListCommand::new));
 /**
Expand Down

60 changes: 60 additions & 0 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/LocalCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.local.RaftMetaConfCommand;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.function.Function;

/**
 * Command for local operation, which no need to connect to ratis server
 */
public class LocalCommand extends AbstractParentCommand {

 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(RaftMetaConfCommand::new));

 /**
 * @param context command context
 */
 public LocalCommand(Context context) {
 super(context, SUB_COMMAND_CONSTRUCTORS);
 }

 @Override
 public String getCommandName() {
 return "local";
 }

 @Override
 public String getDescription() {
 return description();
 }

 /**
 * @return command's description
 */
 public static String description() {
 return "Command for local operation, which no need to connect to ratis server; "
 + "see the sub-commands for the details.";
 }
}

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/PeerCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.peer.AddCommand;
import org.apache.ratis.shell.cli.sh.peer.RemoveCommand;
import org.apache.ratis.shell.cli.sh.peer.SetPriorityCommand;
Expand All@@ -31,7 +32,7 @@
 */
public class PeerCommand extends AbstractParentCommand{

 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(AddCommand::new, RemoveCommand::new,
 SetPriorityCommand::new));

Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/SnapshotCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.snapshot.TakeSnapshotCommand;

import java.util.Arrays;
Expand All@@ -28,7 +29,7 @@
 * Command for the ratis snapshot
 */
public class SnapshotCommand extends AbstractParentCommand {
 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(TakeSnapshotCommand::new));

 /**
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
RATIS-1860. Add ratis-shell cmd to generate a new raft-meta.conf.#901

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

codings-dan
merged 11 commits into

from

Aug 21, 2023
 Merged


RATIS-1860. Add ratis-shell cmd to generate a new raft-meta.conf.
#901
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
672d5f9

Add ratis-shell cmd to generate a new raft-meta.conf.


chunxiaozheng Aug 10, 2023
9b13aae

Remove index option.


chunxiaozheng Aug 15, 2023
8a5556d

Style fix.


chunxiaozheng Aug 15, 2023
24b7d1f

Use GroupCommand as the parent of RaftMetaConfCommand.


chunxiaozheng Aug 16, 2023
74ca5ae

Modified by review comments.


chunxiaozheng Aug 16, 2023
f3c9be2

Update cli.md


chunxiaozheng Aug 16, 2023
1d56bcc

Use LocalCommand as the parent of RaftMetaConfCommand.


chunxiaozheng Aug 18, 2023
7237234

ReConstruct some abstract command.


chunxiaozheng Aug 18, 2023
cb6398a

Modified by review comments.


chunxiaozheng Aug 20, 2023
fece8fb

Use println instead of printf.


chunxiaozheng Aug 20, 2023
f645ea8

Checkstyle error fix(delete some unuse import).


chunxiaozheng Aug 21, 2023

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


12 changes: 12 additions & 0 deletions
ratis-docs/src/site/markdown/cli.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,7 @@ Usage: ratis sh [generic options]
 [group [info] [list]]
 [peer [add] [remove] [setPriority]]
 [snapshot [create]]
 [local [raftMetaConf]]
```

## generic options
Expand DownExpand Up@@ -172,3 +173,14 @@ Trigger the specified server take snapshot.
```
$ ratis sh snapshot create -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -peerId <peerId0> [-groupid <RAFT_GROUP_ID>]
```

## local
The `local` command is used to process local operation, which no need to connect to ratis server.
It has the following subcommands:
`raftMetaConf`

### local raftMetaConf
Generate a new raft-meta.conf file based on original raft-meta.conf and new peers, which is used to move a raft node to a new node.
```
$ ratis sh local raftMetaConf -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -path <PARENT_PATH_OF_RAFT_META_CONF>
```

59 changes: 59 additions & 0 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;

import java.io.PrintStream;
import java.net.InetSocketAddress;

/**
 * The base class for all the ratis shell {@link Command} classes.
 */
public abstract class AbstractCommand implements Command {

 private final PrintStream printStream;

 protected AbstractCommand(Context context) {
 printStream = context.getPrintStream();
 }

 public static InetSocketAddress parseInetSocketAddress(String address) {
 try {
 final String[] hostPortPair = address.split(":");
 if (hostPortPair.length < 2) {
 throw new IllegalArgumentException("Unexpected address format <HOST:PORT>.");
 }
 return new InetSocketAddress(hostPortPair[0], Integer.parseInt(hostPortPair[1]));
 } catch (Exception e) {
 throw new IllegalArgumentException("Failed to parse the server address parameter \"" + address + "\".", e);
 }
 }

 protected PrintStream getPrintStream() {
 return printStream;
 }

 protected void printf(String format, Object... args) {
 printStream.printf(format, args);
 }

 protected void println(Object message) {
 printStream.println(message);
 }
}

5 changes: 2 additions & 3 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractParentCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,11 +26,10 @@
import java.util.function.Function;
import java.util.stream.Collectors;

public abstract class AbstractParentCommand extends AbstractRatisCommand{
public abstract class AbstractParentCommand implements Command {
 private final Map<String, Command> subs;

 public AbstractParentCommand(Context context, List<Function<Context, AbstractRatisCommand>> subCommandConstructors) {
 super(context);
 public AbstractParentCommand(Context context, List<Function<Context, Command>> subCommandConstructors) {
 this.subs = Collections.unmodifiableMap(subCommandConstructors.stream()
 .map(constructor -> constructor.apply(context))
 .collect(Collectors.toMap(Command::getCommandName, Function.identity(),
Expand Down

33 changes: 3 additions & 30 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractRatisCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,6 @@
import org.apache.commons.cli.Option;
import org.apache.ratis.protocol.*;
import org.apache.ratis.protocol.exceptions.RaftException;
import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.RaftUtils;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.Options;
Expand All@@ -34,7 +33,6 @@
import org.apache.ratis.util.function.CheckedFunction;

import java.io.IOException;
import java.io.PrintStream;
import java.net.InetSocketAddress;
import java.util.*;
import java.util.function.BiConsumer;
Expand All@@ -43,25 +41,13 @@
import java.util.stream.Stream;

/**
 * The base class for all the ratis shell {@link Command} classes.
 * The base class for the ratis shell which need to connect to server.
 */
public abstract class AbstractRatisCommand implements Command {
public abstract class AbstractRatisCommand extends AbstractCommand {
 public static final String PEER_OPTION_NAME = "peers";
 public static final String GROUPID_OPTION_NAME = "groupid";
 public static final RaftGroupId DEFAULT_RAFT_GROUP_ID = RaftGroupId.randomId();

 public static InetSocketAddress parseInetSocketAddress(String address) {
 try {
 final String[] hostPortPair = address.split(":");
 if (hostPortPair.length < 2) {
 throw new IllegalArgumentException("Unexpected address format <HOST:PORT>.");
 }
 return new InetSocketAddress(hostPortPair[0], Integer.parseInt(hostPortPair[1]));
 } catch (Exception e) {
 throw new IllegalArgumentException("Failed to parse the server address parameter \"" + address + "\".", e);
 }
 }

 /**
 * Execute a given function with input parameter from the members of a list.
 *
Expand All@@ -86,12 +72,11 @@ public static <T, K, E extends Throwable> K run(Collection<T> list, CheckedFunct
 return null;
 }

 private final PrintStream printStream;
 private RaftGroup raftGroup;
 private GroupInfoReply groupInfoReply;

 protected AbstractRatisCommand(Context context) {
printStream = context.getPrintStream();
super(context);
 }

 @Override
Expand DownExpand Up@@ -154,18 +139,6 @@ public Options getOptions() {
 .addOption(GROUPID_OPTION_NAME, true, "Raft group id");
 }

 protected PrintStream getPrintStream() {
 return printStream;
 }

 protected void printf(String format, Object... args) {
 printStream.printf(format, args);
 }

 protected void println(Object message) {
 printStream.println(message);
 }

 protected RaftGroup getRaftGroup() {
 return raftGroup;
 }
Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/ElectionCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.election.PauseCommand;
import org.apache.ratis.shell.cli.sh.election.ResumeCommand;
import org.apache.ratis.shell.cli.sh.election.StepDownCommand;
Expand All@@ -28,7 +29,7 @@
import java.util.function.Function;

public class ElectionCommand extends AbstractParentCommand {
 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(
 TransferCommand::new, StepDownCommand::new, PauseCommand::new, ResumeCommand::new));

Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/GroupCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.group.GroupInfoCommand;
import org.apache.ratis.shell.cli.sh.group.GroupListCommand;

Expand All@@ -30,7 +31,7 @@
 */
public class GroupCommand extends AbstractParentCommand {

 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(
 GroupInfoCommand::new, GroupListCommand::new));
 /**
Expand Down

60 changes: 60 additions & 0 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/LocalCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.local.RaftMetaConfCommand;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.function.Function;

/**
 * Command for local operation, which no need to connect to ratis server
 */
public class LocalCommand extends AbstractParentCommand {

 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(RaftMetaConfCommand::new));

 /**
 * @param context command context
 */
 public LocalCommand(Context context) {
 super(context, SUB_COMMAND_CONSTRUCTORS);
 }

 @Override
 public String getCommandName() {
 return "local";
 }

 @Override
 public String getDescription() {
 return description();
 }

 /**
 * @return command's description
 */
 public static String description() {
 return "Command for local operation, which no need to connect to ratis server; "
 + "see the sub-commands for the details.";
 }
}

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/PeerCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.peer.AddCommand;
import org.apache.ratis.shell.cli.sh.peer.RemoveCommand;
import org.apache.ratis.shell.cli.sh.peer.SetPriorityCommand;
Expand All@@ -31,7 +32,7 @@
 */
public class PeerCommand extends AbstractParentCommand{

 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(AddCommand::new, RemoveCommand::new,
 SetPriorityCommand::new));

Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/SnapshotCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.snapshot.TakeSnapshotCommand;

import java.util.Arrays;
Expand All@@ -28,7 +29,7 @@
 * Command for the ratis snapshot
 */
public class SnapshotCommand extends AbstractParentCommand {
 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(TakeSnapshotCommand::new));

 /**
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
RATIS-1860. Add ratis-shell cmd to generate a new raft-meta.conf.#901

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

codings-dan
merged 11 commits into

from

Aug 21, 2023
 Merged


RATIS-1860. Add ratis-shell cmd to generate a new raft-meta.conf.
#901
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
672d5f9

Add ratis-shell cmd to generate a new raft-meta.conf.


chunxiaozheng Aug 10, 2023
9b13aae

Remove index option.


chunxiaozheng Aug 15, 2023
8a5556d

Style fix.


chunxiaozheng Aug 15, 2023
24b7d1f

Use GroupCommand as the parent of RaftMetaConfCommand.


chunxiaozheng Aug 16, 2023
74ca5ae

Modified by review comments.


chunxiaozheng Aug 16, 2023
f3c9be2

Update cli.md


chunxiaozheng Aug 16, 2023
1d56bcc

Use LocalCommand as the parent of RaftMetaConfCommand.


chunxiaozheng Aug 18, 2023
7237234

ReConstruct some abstract command.


chunxiaozheng Aug 18, 2023
cb6398a

Modified by review comments.


chunxiaozheng Aug 20, 2023
fece8fb

Use println instead of printf.


chunxiaozheng Aug 20, 2023
f645ea8

Checkstyle error fix(delete some unuse import).


chunxiaozheng Aug 21, 2023

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


12 changes: 12 additions & 0 deletions
ratis-docs/src/site/markdown/cli.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,7 @@ Usage: ratis sh [generic options]
 [group [info] [list]]
 [peer [add] [remove] [setPriority]]
 [snapshot [create]]
 [local [raftMetaConf]]
```

## generic options
Expand DownExpand Up@@ -172,3 +173,14 @@ Trigger the specified server take snapshot.
```
$ ratis sh snapshot create -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -peerId <peerId0> [-groupid <RAFT_GROUP_ID>]
```

## local
The `local` command is used to process local operation, which no need to connect to ratis server.
It has the following subcommands:
`raftMetaConf`

### local raftMetaConf
Generate a new raft-meta.conf file based on original raft-meta.conf and new peers, which is used to move a raft node to a new node.
```
$ ratis sh local raftMetaConf -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -path <PARENT_PATH_OF_RAFT_META_CONF>
```

59 changes: 59 additions & 0 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;

import java.io.PrintStream;
import java.net.InetSocketAddress;

/**
 * The base class for all the ratis shell {@link Command} classes.
 */
public abstract class AbstractCommand implements Command {

 private final PrintStream printStream;

 protected AbstractCommand(Context context) {
 printStream = context.getPrintStream();
 }

 public static InetSocketAddress parseInetSocketAddress(String address) {
 try {
 final String[] hostPortPair = address.split(":");
 if (hostPortPair.length < 2) {
 throw new IllegalArgumentException("Unexpected address format <HOST:PORT>.");
 }
 return new InetSocketAddress(hostPortPair[0], Integer.parseInt(hostPortPair[1]));
 } catch (Exception e) {
 throw new IllegalArgumentException("Failed to parse the server address parameter \"" + address + "\".", e);
 }
 }

 protected PrintStream getPrintStream() {
 return printStream;
 }

 protected void printf(String format, Object... args) {
 printStream.printf(format, args);
 }

 protected void println(Object message) {
 printStream.println(message);
 }
}

5 changes: 2 additions & 3 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractParentCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,11 +26,10 @@
import java.util.function.Function;
import java.util.stream.Collectors;

public abstract class AbstractParentCommand extends AbstractRatisCommand{
public abstract class AbstractParentCommand implements Command {
 private final Map<String, Command> subs;

 public AbstractParentCommand(Context context, List<Function<Context, AbstractRatisCommand>> subCommandConstructors) {
 super(context);
 public AbstractParentCommand(Context context, List<Function<Context, Command>> subCommandConstructors) {
 this.subs = Collections.unmodifiableMap(subCommandConstructors.stream()
 .map(constructor -> constructor.apply(context))
 .collect(Collectors.toMap(Command::getCommandName, Function.identity(),
Expand Down

33 changes: 3 additions & 30 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractRatisCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,6 @@
import org.apache.commons.cli.Option;
import org.apache.ratis.protocol.*;
import org.apache.ratis.protocol.exceptions.RaftException;
import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.RaftUtils;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.Options;
Expand All@@ -34,7 +33,6 @@
import org.apache.ratis.util.function.CheckedFunction;

import java.io.IOException;
import java.io.PrintStream;
import java.net.InetSocketAddress;
import java.util.*;
import java.util.function.BiConsumer;
Expand All@@ -43,25 +41,13 @@
import java.util.stream.Stream;

/**
 * The base class for all the ratis shell {@link Command} classes.
 * The base class for the ratis shell which need to connect to server.
 */
public abstract class AbstractRatisCommand implements Command {
public abstract class AbstractRatisCommand extends AbstractCommand {
 public static final String PEER_OPTION_NAME = "peers";
 public static final String GROUPID_OPTION_NAME = "groupid";
 public static final RaftGroupId DEFAULT_RAFT_GROUP_ID = RaftGroupId.randomId();

 public static InetSocketAddress parseInetSocketAddress(String address) {
 try {
 final String[] hostPortPair = address.split(":");
 if (hostPortPair.length < 2) {
 throw new IllegalArgumentException("Unexpected address format <HOST:PORT>.");
 }
 return new InetSocketAddress(hostPortPair[0], Integer.parseInt(hostPortPair[1]));
 } catch (Exception e) {
 throw new IllegalArgumentException("Failed to parse the server address parameter \"" + address + "\".", e);
 }
 }

 /**
 * Execute a given function with input parameter from the members of a list.
 *
Expand All@@ -86,12 +72,11 @@ public static <T, K, E extends Throwable> K run(Collection<T> list, CheckedFunct
 return null;
 }

 private final PrintStream printStream;
 private RaftGroup raftGroup;
 private GroupInfoReply groupInfoReply;

 protected AbstractRatisCommand(Context context) {
printStream = context.getPrintStream();
super(context);
 }

 @Override
Expand DownExpand Up@@ -154,18 +139,6 @@ public Options getOptions() {
 .addOption(GROUPID_OPTION_NAME, true, "Raft group id");
 }

 protected PrintStream getPrintStream() {
 return printStream;
 }

 protected void printf(String format, Object... args) {
 printStream.printf(format, args);
 }

 protected void println(Object message) {
 printStream.println(message);
 }

 protected RaftGroup getRaftGroup() {
 return raftGroup;
 }
Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/ElectionCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.election.PauseCommand;
import org.apache.ratis.shell.cli.sh.election.ResumeCommand;
import org.apache.ratis.shell.cli.sh.election.StepDownCommand;
Expand All@@ -28,7 +29,7 @@
import java.util.function.Function;

public class ElectionCommand extends AbstractParentCommand {
 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(
 TransferCommand::new, StepDownCommand::new, PauseCommand::new, ResumeCommand::new));

Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/GroupCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.group.GroupInfoCommand;
import org.apache.ratis.shell.cli.sh.group.GroupListCommand;

Expand All@@ -30,7 +31,7 @@
 */
public class GroupCommand extends AbstractParentCommand {

 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(
 GroupInfoCommand::new, GroupListCommand::new));
 /**
Expand Down

60 changes: 60 additions & 0 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/LocalCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.local.RaftMetaConfCommand;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.function.Function;

/**
 * Command for local operation, which no need to connect to ratis server
 */
public class LocalCommand extends AbstractParentCommand {

 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(RaftMetaConfCommand::new));

 /**
 * @param context command context
 */
 public LocalCommand(Context context) {
 super(context, SUB_COMMAND_CONSTRUCTORS);
 }

 @Override
 public String getCommandName() {
 return "local";
 }

 @Override
 public String getDescription() {
 return description();
 }

 /**
 * @return command's description
 */
 public static String description() {
 return "Command for local operation, which no need to connect to ratis server; "
 + "see the sub-commands for the details.";
 }
}

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/PeerCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.peer.AddCommand;
import org.apache.ratis.shell.cli.sh.peer.RemoveCommand;
import org.apache.ratis.shell.cli.sh.peer.SetPriorityCommand;
Expand All@@ -31,7 +32,7 @@
 */
public class PeerCommand extends AbstractParentCommand{

 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(AddCommand::new, RemoveCommand::new,
 SetPriorityCommand::new));

Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/SnapshotCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.snapshot.TakeSnapshotCommand;

import java.util.Arrays;
Expand All@@ -28,7 +29,7 @@
 * Command for the ratis snapshot
 */
public class SnapshotCommand extends AbstractParentCommand {
 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(TakeSnapshotCommand::new));

 /**
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
RATIS-1860. Add ratis-shell cmd to generate a new raft-meta.conf.#901

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

codings-dan
merged 11 commits into

from

Aug 21, 2023
 Merged


RATIS-1860. Add ratis-shell cmd to generate a new raft-meta.conf.
#901
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
672d5f9

Add ratis-shell cmd to generate a new raft-meta.conf.


chunxiaozheng Aug 10, 2023
9b13aae

Remove index option.


chunxiaozheng Aug 15, 2023
8a5556d

Style fix.


chunxiaozheng Aug 15, 2023
24b7d1f

Use GroupCommand as the parent of RaftMetaConfCommand.


chunxiaozheng Aug 16, 2023
74ca5ae

Modified by review comments.


chunxiaozheng Aug 16, 2023
f3c9be2

Update cli.md


chunxiaozheng Aug 16, 2023
1d56bcc

Use LocalCommand as the parent of RaftMetaConfCommand.


chunxiaozheng Aug 18, 2023
7237234

ReConstruct some abstract command.


chunxiaozheng Aug 18, 2023
cb6398a

Modified by review comments.


chunxiaozheng Aug 20, 2023
fece8fb

Use println instead of printf.


chunxiaozheng Aug 20, 2023
f645ea8

Checkstyle error fix(delete some unuse import).


chunxiaozheng Aug 21, 2023

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


12 changes: 12 additions & 0 deletions
ratis-docs/src/site/markdown/cli.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,7 @@ Usage: ratis sh [generic options]
 [group [info] [list]]
 [peer [add] [remove] [setPriority]]
 [snapshot [create]]
 [local [raftMetaConf]]
```

## generic options
Expand DownExpand Up@@ -172,3 +173,14 @@ Trigger the specified server take snapshot.
```
$ ratis sh snapshot create -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -peerId <peerId0> [-groupid <RAFT_GROUP_ID>]
```

## local
The `local` command is used to process local operation, which no need to connect to ratis server.
It has the following subcommands:
`raftMetaConf`

### local raftMetaConf
Generate a new raft-meta.conf file based on original raft-meta.conf and new peers, which is used to move a raft node to a new node.
```
$ ratis sh local raftMetaConf -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -path <PARENT_PATH_OF_RAFT_META_CONF>
```

59 changes: 59 additions & 0 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;

import java.io.PrintStream;
import java.net.InetSocketAddress;

/**
 * The base class for all the ratis shell {@link Command} classes.
 */
public abstract class AbstractCommand implements Command {

 private final PrintStream printStream;

 protected AbstractCommand(Context context) {
 printStream = context.getPrintStream();
 }

 public static InetSocketAddress parseInetSocketAddress(String address) {
 try {
 final String[] hostPortPair = address.split(":");
 if (hostPortPair.length < 2) {
 throw new IllegalArgumentException("Unexpected address format <HOST:PORT>.");
 }
 return new InetSocketAddress(hostPortPair[0], Integer.parseInt(hostPortPair[1]));
 } catch (Exception e) {
 throw new IllegalArgumentException("Failed to parse the server address parameter \"" + address + "\".", e);
 }
 }

 protected PrintStream getPrintStream() {
 return printStream;
 }

 protected void printf(String format, Object... args) {
 printStream.printf(format, args);
 }

 protected void println(Object message) {
 printStream.println(message);
 }
}

5 changes: 2 additions & 3 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractParentCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,11 +26,10 @@
import java.util.function.Function;
import java.util.stream.Collectors;

public abstract class AbstractParentCommand extends AbstractRatisCommand{
public abstract class AbstractParentCommand implements Command {
 private final Map<String, Command> subs;

 public AbstractParentCommand(Context context, List<Function<Context, AbstractRatisCommand>> subCommandConstructors) {
 super(context);
 public AbstractParentCommand(Context context, List<Function<Context, Command>> subCommandConstructors) {
 this.subs = Collections.unmodifiableMap(subCommandConstructors.stream()
 .map(constructor -> constructor.apply(context))
 .collect(Collectors.toMap(Command::getCommandName, Function.identity(),
Expand Down

33 changes: 3 additions & 30 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractRatisCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,6 @@
import org.apache.commons.cli.Option;
import org.apache.ratis.protocol.*;
import org.apache.ratis.protocol.exceptions.RaftException;
import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.RaftUtils;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.Options;
Expand All@@ -34,7 +33,6 @@
import org.apache.ratis.util.function.CheckedFunction;

import java.io.IOException;
import java.io.PrintStream;
import java.net.InetSocketAddress;
import java.util.*;
import java.util.function.BiConsumer;
Expand All@@ -43,25 +41,13 @@
import java.util.stream.Stream;

/**
 * The base class for all the ratis shell {@link Command} classes.
 * The base class for the ratis shell which need to connect to server.
 */
public abstract class AbstractRatisCommand implements Command {
public abstract class AbstractRatisCommand extends AbstractCommand {
 public static final String PEER_OPTION_NAME = "peers";
 public static final String GROUPID_OPTION_NAME = "groupid";
 public static final RaftGroupId DEFAULT_RAFT_GROUP_ID = RaftGroupId.randomId();

 public static InetSocketAddress parseInetSocketAddress(String address) {
 try {
 final String[] hostPortPair = address.split(":");
 if (hostPortPair.length < 2) {
 throw new IllegalArgumentException("Unexpected address format <HOST:PORT>.");
 }
 return new InetSocketAddress(hostPortPair[0], Integer.parseInt(hostPortPair[1]));
 } catch (Exception e) {
 throw new IllegalArgumentException("Failed to parse the server address parameter \"" + address + "\".", e);
 }
 }

 /**
 * Execute a given function with input parameter from the members of a list.
 *
Expand All@@ -86,12 +72,11 @@ public static <T, K, E extends Throwable> K run(Collection<T> list, CheckedFunct
 return null;
 }

 private final PrintStream printStream;
 private RaftGroup raftGroup;
 private GroupInfoReply groupInfoReply;

 protected AbstractRatisCommand(Context context) {
printStream = context.getPrintStream();
super(context);
 }

 @Override
Expand DownExpand Up@@ -154,18 +139,6 @@ public Options getOptions() {
 .addOption(GROUPID_OPTION_NAME, true, "Raft group id");
 }

 protected PrintStream getPrintStream() {
 return printStream;
 }

 protected void printf(String format, Object... args) {
 printStream.printf(format, args);
 }

 protected void println(Object message) {
 printStream.println(message);
 }

 protected RaftGroup getRaftGroup() {
 return raftGroup;
 }
Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/ElectionCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.election.PauseCommand;
import org.apache.ratis.shell.cli.sh.election.ResumeCommand;
import org.apache.ratis.shell.cli.sh.election.StepDownCommand;
Expand All@@ -28,7 +29,7 @@
import java.util.function.Function;

public class ElectionCommand extends AbstractParentCommand {
 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(
 TransferCommand::new, StepDownCommand::new, PauseCommand::new, ResumeCommand::new));

Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/GroupCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.group.GroupInfoCommand;
import org.apache.ratis.shell.cli.sh.group.GroupListCommand;

Expand All@@ -30,7 +31,7 @@
 */
public class GroupCommand extends AbstractParentCommand {

 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(
 GroupInfoCommand::new, GroupListCommand::new));
 /**
Expand Down

60 changes: 60 additions & 0 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/LocalCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.local.RaftMetaConfCommand;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.function.Function;

/**
 * Command for local operation, which no need to connect to ratis server
 */
public class LocalCommand extends AbstractParentCommand {

 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(RaftMetaConfCommand::new));

 /**
 * @param context command context
 */
 public LocalCommand(Context context) {
 super(context, SUB_COMMAND_CONSTRUCTORS);
 }

 @Override
 public String getCommandName() {
 return "local";
 }

 @Override
 public String getDescription() {
 return description();
 }

 /**
 * @return command's description
 */
 public static String description() {
 return "Command for local operation, which no need to connect to ratis server; "
 + "see the sub-commands for the details.";
 }
}

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/PeerCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.peer.AddCommand;
import org.apache.ratis.shell.cli.sh.peer.RemoveCommand;
import org.apache.ratis.shell.cli.sh.peer.SetPriorityCommand;
Expand All@@ -31,7 +32,7 @@
 */
public class PeerCommand extends AbstractParentCommand{

 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(AddCommand::new, RemoveCommand::new,
 SetPriorityCommand::new));

Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/SnapshotCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.snapshot.TakeSnapshotCommand;

import java.util.Arrays;
Expand All@@ -28,7 +29,7 @@
 * Command for the ratis snapshot
 */
public class SnapshotCommand extends AbstractParentCommand {
 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(TakeSnapshotCommand::new));

 /**
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
RATIS-1860. Add ratis-shell cmd to generate a new raft-meta.conf.#901

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

codings-dan
merged 11 commits into

from

Aug 21, 2023
 Merged


RATIS-1860. Add ratis-shell cmd to generate a new raft-meta.conf.
#901
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
672d5f9

Add ratis-shell cmd to generate a new raft-meta.conf.


chunxiaozheng Aug 10, 2023
9b13aae

Remove index option.


chunxiaozheng Aug 15, 2023
8a5556d

Style fix.


chunxiaozheng Aug 15, 2023
24b7d1f

Use GroupCommand as the parent of RaftMetaConfCommand.


chunxiaozheng Aug 16, 2023
74ca5ae

Modified by review comments.


chunxiaozheng Aug 16, 2023
f3c9be2

Update cli.md


chunxiaozheng Aug 16, 2023
1d56bcc

Use LocalCommand as the parent of RaftMetaConfCommand.


chunxiaozheng Aug 18, 2023
7237234

ReConstruct some abstract command.


chunxiaozheng Aug 18, 2023
cb6398a

Modified by review comments.


chunxiaozheng Aug 20, 2023
fece8fb

Use println instead of printf.


chunxiaozheng Aug 20, 2023
f645ea8

Checkstyle error fix(delete some unuse import).


chunxiaozheng Aug 21, 2023

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


12 changes: 12 additions & 0 deletions
ratis-docs/src/site/markdown/cli.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,7 @@ Usage: ratis sh [generic options]
 [group [info] [list]]
 [peer [add] [remove] [setPriority]]
 [snapshot [create]]
 [local [raftMetaConf]]
```

## generic options
Expand DownExpand Up@@ -172,3 +173,14 @@ Trigger the specified server take snapshot.
```
$ ratis sh snapshot create -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -peerId <peerId0> [-groupid <RAFT_GROUP_ID>]
```

## local
The `local` command is used to process local operation, which no need to connect to ratis server.
It has the following subcommands:
`raftMetaConf`

### local raftMetaConf
Generate a new raft-meta.conf file based on original raft-meta.conf and new peers, which is used to move a raft node to a new node.
```
$ ratis sh local raftMetaConf -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -path <PARENT_PATH_OF_RAFT_META_CONF>
```

59 changes: 59 additions & 0 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;

import java.io.PrintStream;
import java.net.InetSocketAddress;

/**
 * The base class for all the ratis shell {@link Command} classes.
 */
public abstract class AbstractCommand implements Command {

 private final PrintStream printStream;

 protected AbstractCommand(Context context) {
 printStream = context.getPrintStream();
 }

 public static InetSocketAddress parseInetSocketAddress(String address) {
 try {
 final String[] hostPortPair = address.split(":");
 if (hostPortPair.length < 2) {
 throw new IllegalArgumentException("Unexpected address format <HOST:PORT>.");
 }
 return new InetSocketAddress(hostPortPair[0], Integer.parseInt(hostPortPair[1]));
 } catch (Exception e) {
 throw new IllegalArgumentException("Failed to parse the server address parameter \"" + address + "\".", e);
 }
 }

 protected PrintStream getPrintStream() {
 return printStream;
 }

 protected void printf(String format, Object... args) {
 printStream.printf(format, args);
 }

 protected void println(Object message) {
 printStream.println(message);
 }
}

5 changes: 2 additions & 3 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractParentCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,11 +26,10 @@
import java.util.function.Function;
import java.util.stream.Collectors;

public abstract class AbstractParentCommand extends AbstractRatisCommand{
public abstract class AbstractParentCommand implements Command {
 private final Map<String, Command> subs;

 public AbstractParentCommand(Context context, List<Function<Context, AbstractRatisCommand>> subCommandConstructors) {
 super(context);
 public AbstractParentCommand(Context context, List<Function<Context, Command>> subCommandConstructors) {
 this.subs = Collections.unmodifiableMap(subCommandConstructors.stream()
 .map(constructor -> constructor.apply(context))
 .collect(Collectors.toMap(Command::getCommandName, Function.identity(),
Expand Down

33 changes: 3 additions & 30 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractRatisCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,6 @@
import org.apache.commons.cli.Option;
import org.apache.ratis.protocol.*;
import org.apache.ratis.protocol.exceptions.RaftException;
import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.RaftUtils;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.Options;
Expand All@@ -34,7 +33,6 @@
import org.apache.ratis.util.function.CheckedFunction;

import java.io.IOException;
import java.io.PrintStream;
import java.net.InetSocketAddress;
import java.util.*;
import java.util.function.BiConsumer;
Expand All@@ -43,25 +41,13 @@
import java.util.stream.Stream;

/**
 * The base class for all the ratis shell {@link Command} classes.
 * The base class for the ratis shell which need to connect to server.
 */
public abstract class AbstractRatisCommand implements Command {
public abstract class AbstractRatisCommand extends AbstractCommand {
 public static final String PEER_OPTION_NAME = "peers";
 public static final String GROUPID_OPTION_NAME = "groupid";
 public static final RaftGroupId DEFAULT_RAFT_GROUP_ID = RaftGroupId.randomId();

 public static InetSocketAddress parseInetSocketAddress(String address) {
 try {
 final String[] hostPortPair = address.split(":");
 if (hostPortPair.length < 2) {
 throw new IllegalArgumentException("Unexpected address format <HOST:PORT>.");
 }
 return new InetSocketAddress(hostPortPair[0], Integer.parseInt(hostPortPair[1]));
 } catch (Exception e) {
 throw new IllegalArgumentException("Failed to parse the server address parameter \"" + address + "\".", e);
 }
 }

 /**
 * Execute a given function with input parameter from the members of a list.
 *
Expand All@@ -86,12 +72,11 @@ public static <T, K, E extends Throwable> K run(Collection<T> list, CheckedFunct
 return null;
 }

 private final PrintStream printStream;
 private RaftGroup raftGroup;
 private GroupInfoReply groupInfoReply;

 protected AbstractRatisCommand(Context context) {
printStream = context.getPrintStream();
super(context);
 }

 @Override
Expand DownExpand Up@@ -154,18 +139,6 @@ public Options getOptions() {
 .addOption(GROUPID_OPTION_NAME, true, "Raft group id");
 }

 protected PrintStream getPrintStream() {
 return printStream;
 }

 protected void printf(String format, Object... args) {
 printStream.printf(format, args);
 }

 protected void println(Object message) {
 printStream.println(message);
 }

 protected RaftGroup getRaftGroup() {
 return raftGroup;
 }
Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/ElectionCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.election.PauseCommand;
import org.apache.ratis.shell.cli.sh.election.ResumeCommand;
import org.apache.ratis.shell.cli.sh.election.StepDownCommand;
Expand All@@ -28,7 +29,7 @@
import java.util.function.Function;

public class ElectionCommand extends AbstractParentCommand {
 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(
 TransferCommand::new, StepDownCommand::new, PauseCommand::new, ResumeCommand::new));

Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/GroupCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.group.GroupInfoCommand;
import org.apache.ratis.shell.cli.sh.group.GroupListCommand;

Expand All@@ -30,7 +31,7 @@
 */
public class GroupCommand extends AbstractParentCommand {

 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(
 GroupInfoCommand::new, GroupListCommand::new));
 /**
Expand Down

60 changes: 60 additions & 0 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/LocalCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.local.RaftMetaConfCommand;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.function.Function;

/**
 * Command for local operation, which no need to connect to ratis server
 */
public class LocalCommand extends AbstractParentCommand {

 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(RaftMetaConfCommand::new));

 /**
 * @param context command context
 */
 public LocalCommand(Context context) {
 super(context, SUB_COMMAND_CONSTRUCTORS);
 }

 @Override
 public String getCommandName() {
 return "local";
 }

 @Override
 public String getDescription() {
 return description();
 }

 /**
 * @return command's description
 */
 public static String description() {
 return "Command for local operation, which no need to connect to ratis server; "
 + "see the sub-commands for the details.";
 }
}

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/PeerCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.peer.AddCommand;
import org.apache.ratis.shell.cli.sh.peer.RemoveCommand;
import org.apache.ratis.shell.cli.sh.peer.SetPriorityCommand;
Expand All@@ -31,7 +32,7 @@
 */
public class PeerCommand extends AbstractParentCommand{

 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(AddCommand::new, RemoveCommand::new,
 SetPriorityCommand::new));

Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/SnapshotCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.snapshot.TakeSnapshotCommand;

import java.util.Arrays;
Expand All@@ -28,7 +29,7 @@
 * Command for the ratis snapshot
 */
public class SnapshotCommand extends AbstractParentCommand {
 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(TakeSnapshotCommand::new));

 /**
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
RATIS-1860. Add ratis-shell cmd to generate a new raft-meta.conf.#901

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

codings-dan
merged 11 commits into

from

Aug 21, 2023
 Merged


RATIS-1860. Add ratis-shell cmd to generate a new raft-meta.conf.
#901
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


11 commits


Select commit
Hold shift + click to select a range
672d5f9

Add ratis-shell cmd to generate a new raft-meta.conf.


chunxiaozheng Aug 10, 2023
9b13aae

Remove index option.


chunxiaozheng Aug 15, 2023
8a5556d

Style fix.


chunxiaozheng Aug 15, 2023
24b7d1f

Use GroupCommand as the parent of RaftMetaConfCommand.


chunxiaozheng Aug 16, 2023
74ca5ae

Modified by review comments.


chunxiaozheng Aug 16, 2023
f3c9be2

Update cli.md


chunxiaozheng Aug 16, 2023
1d56bcc

Use LocalCommand as the parent of RaftMetaConfCommand.


chunxiaozheng Aug 18, 2023
7237234

ReConstruct some abstract command.


chunxiaozheng Aug 18, 2023
cb6398a

Modified by review comments.


chunxiaozheng Aug 20, 2023
fece8fb

Use println instead of printf.


chunxiaozheng Aug 20, 2023
f645ea8

Checkstyle error fix(delete some unuse import).


chunxiaozheng Aug 21, 2023

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


12 changes: 12 additions & 0 deletions
ratis-docs/src/site/markdown/cli.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -80,6 +80,7 @@ Usage: ratis sh [generic options]
 [group [info] [list]]
 [peer [add] [remove] [setPriority]]
 [snapshot [create]]
 [local [raftMetaConf]]
```

## generic options
Expand DownExpand Up@@ -172,3 +173,14 @@ Trigger the specified server take snapshot.
```
$ ratis sh snapshot create -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -peerId <peerId0> [-groupid <RAFT_GROUP_ID>]
```

## local
The `local` command is used to process local operation, which no need to connect to ratis server.
It has the following subcommands:
`raftMetaConf`

### local raftMetaConf
Generate a new raft-meta.conf file based on original raft-meta.conf and new peers, which is used to move a raft node to a new node.
```
$ ratis sh local raftMetaConf -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -path <PARENT_PATH_OF_RAFT_META_CONF>
```

59 changes: 59 additions & 0 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;

import java.io.PrintStream;
import java.net.InetSocketAddress;

/**
 * The base class for all the ratis shell {@link Command} classes.
 */
public abstract class AbstractCommand implements Command {

 private final PrintStream printStream;

 protected AbstractCommand(Context context) {
 printStream = context.getPrintStream();
 }

 public static InetSocketAddress parseInetSocketAddress(String address) {
 try {
 final String[] hostPortPair = address.split(":");
 if (hostPortPair.length < 2) {
 throw new IllegalArgumentException("Unexpected address format <HOST:PORT>.");
 }
 return new InetSocketAddress(hostPortPair[0], Integer.parseInt(hostPortPair[1]));
 } catch (Exception e) {
 throw new IllegalArgumentException("Failed to parse the server address parameter \"" + address + "\".", e);
 }
 }

 protected PrintStream getPrintStream() {
 return printStream;
 }

 protected void printf(String format, Object... args) {
 printStream.printf(format, args);
 }

 protected void println(Object message) {
 printStream.println(message);
 }
}

5 changes: 2 additions & 3 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractParentCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -26,11 +26,10 @@
import java.util.function.Function;
import java.util.stream.Collectors;

public abstract class AbstractParentCommand extends AbstractRatisCommand{
public abstract class AbstractParentCommand implements Command {
 private final Map<String, Command> subs;

 public AbstractParentCommand(Context context, List<Function<Context, AbstractRatisCommand>> subCommandConstructors) {
 super(context);
 public AbstractParentCommand(Context context, List<Function<Context, Command>> subCommandConstructors) {
 this.subs = Collections.unmodifiableMap(subCommandConstructors.stream()
 .map(constructor -> constructor.apply(context))
 .collect(Collectors.toMap(Command::getCommandName, Function.identity(),
Expand Down

33 changes: 3 additions & 30 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/AbstractRatisCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -20,7 +20,6 @@
import org.apache.commons.cli.Option;
import org.apache.ratis.protocol.*;
import org.apache.ratis.protocol.exceptions.RaftException;
import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.RaftUtils;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.Options;
Expand All@@ -34,7 +33,6 @@
import org.apache.ratis.util.function.CheckedFunction;

import java.io.IOException;
import java.io.PrintStream;
import java.net.InetSocketAddress;
import java.util.*;
import java.util.function.BiConsumer;
Expand All@@ -43,25 +41,13 @@
import java.util.stream.Stream;

/**
 * The base class for all the ratis shell {@link Command} classes.
 * The base class for the ratis shell which need to connect to server.
 */
public abstract class AbstractRatisCommand implements Command {
public abstract class AbstractRatisCommand extends AbstractCommand {
 public static final String PEER_OPTION_NAME = "peers";
 public static final String GROUPID_OPTION_NAME = "groupid";
 public static final RaftGroupId DEFAULT_RAFT_GROUP_ID = RaftGroupId.randomId();

 public static InetSocketAddress parseInetSocketAddress(String address) {
 try {
 final String[] hostPortPair = address.split(":");
 if (hostPortPair.length < 2) {
 throw new IllegalArgumentException("Unexpected address format <HOST:PORT>.");
 }
 return new InetSocketAddress(hostPortPair[0], Integer.parseInt(hostPortPair[1]));
 } catch (Exception e) {
 throw new IllegalArgumentException("Failed to parse the server address parameter \"" + address + "\".", e);
 }
 }

 /**
 * Execute a given function with input parameter from the members of a list.
 *
Expand All@@ -86,12 +72,11 @@ public static <T, K, E extends Throwable> K run(Collection<T> list, CheckedFunct
 return null;
 }

 private final PrintStream printStream;
 private RaftGroup raftGroup;
 private GroupInfoReply groupInfoReply;

 protected AbstractRatisCommand(Context context) {
printStream = context.getPrintStream();
super(context);
 }

 @Override
Expand DownExpand Up@@ -154,18 +139,6 @@ public Options getOptions() {
 .addOption(GROUPID_OPTION_NAME, true, "Raft group id");
 }

 protected PrintStream getPrintStream() {
 return printStream;
 }

 protected void printf(String format, Object... args) {
 printStream.printf(format, args);
 }

 protected void println(Object message) {
 printStream.println(message);
 }

 protected RaftGroup getRaftGroup() {
 return raftGroup;
 }
Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/ElectionCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.election.PauseCommand;
import org.apache.ratis.shell.cli.sh.election.ResumeCommand;
import org.apache.ratis.shell.cli.sh.election.StepDownCommand;
Expand All@@ -28,7 +29,7 @@
import java.util.function.Function;

public class ElectionCommand extends AbstractParentCommand {
 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(
 TransferCommand::new, StepDownCommand::new, PauseCommand::new, ResumeCommand::new));

Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/GroupCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.group.GroupInfoCommand;
import org.apache.ratis.shell.cli.sh.group.GroupListCommand;

Expand All@@ -30,7 +31,7 @@
 */
public class GroupCommand extends AbstractParentCommand {

 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(
 GroupInfoCommand::new, GroupListCommand::new));
 /**
Expand Down

60 changes: 60 additions & 0 deletions
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/LocalCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.local.RaftMetaConfCommand;

import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.function.Function;

/**
 * Command for local operation, which no need to connect to ratis server
 */
public class LocalCommand extends AbstractParentCommand {

 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(RaftMetaConfCommand::new));

 /**
 * @param context command context
 */
 public LocalCommand(Context context) {
 super(context, SUB_COMMAND_CONSTRUCTORS);
 }

 @Override
 public String getCommandName() {
 return "local";
 }

 @Override
 public String getDescription() {
 return description();
 }

 /**
 * @return command's description
 */
 public static String description() {
 return "Command for local operation, which no need to connect to ratis server; "
 + "see the sub-commands for the details.";
 }
}

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/PeerCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.peer.AddCommand;
import org.apache.ratis.shell.cli.sh.peer.RemoveCommand;
import org.apache.ratis.shell.cli.sh.peer.SetPriorityCommand;
Expand All@@ -31,7 +32,7 @@
 */
public class PeerCommand extends AbstractParentCommand{

 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(AddCommand::new, RemoveCommand::new,
 SetPriorityCommand::new));

Expand Down

3 changes: 2 additions & 1 deletion
ratis-shell/src/main/java/org/apache/ratis/shell/cli/sh/command/SnapshotCommand.java

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@
 */
package org.apache.ratis.shell.cli.sh.command;

import org.apache.ratis.shell.cli.Command;
import org.apache.ratis.shell.cli.sh.snapshot.TakeSnapshotCommand;

import java.util.Arrays;
Expand All@@ -28,7 +29,7 @@
 * Command for the ratis snapshot
 */
public class SnapshotCommand extends AbstractParentCommand {
 private static final List<Function<Context, AbstractRatisCommand>> SUB_COMMAND_CONSTRUCTORS
 private static final List<Function<Context, Command>> SUB_COMMAND_CONSTRUCTORS
 = Collections.unmodifiableList(Arrays.asList(TakeSnapshotCommand::new));

 /**
Expand Down
Loading