cmdbox.app.features.cli.cmdbox package
Submodules
cmdbox.app.features.cli.cmdbox.cmdbox_base module
- class cmdbox.app.features.cli.cmdbox.cmdbox_base.CmdboxBase(appcls, ver, language: str = None)[source]
Bases:
OneshotEdgeFeature- copy_scripts(logger: Logger, container: str) Path[source]
モジュール内のスクリプトをホストにコピーします。 :param logger: ロガー :type logger: logging.Logger :param container: コンテナ名 :type container: str
- Returns:
コピー先のパス
- Return type:
Path
- down(logger: Logger, container: str = None) Dict[str, Any][source]
コンテナを停止します。
- Parameters:
logger (logging.Logger) -- ロガー
container (str) -- コンテナ名
- Returns:
処理結果
- Return type:
dict
- exec(logger: Logger, compose_path: str = None, container: str = None, command: str = None) Dict[str, Any][source]
cmdboxサーバーコンテナ内で任意のコマンドを実行します。
- Parameters:
logger (logging.Logger) -- ロガー
compose_path (str) -- docker-compose.ymlファイルパス
container (str) -- コンテナ名
command (str) -- 実行するコマンド
- Returns:
処理結果
- Return type:
dict
- get_imgname(container: str, args: Namespace) str[source]
イメージ名を取得します
- Parameters:
container (str) -- コンテナ名
args (argparse.Namespace) -- 引数
- Returns:
イメージ名
- Return type:
str
- load(logger: Logger, compose_path: str = None, container: str = None, install_tag: str = None, file: str = None) Dict[str, Any][source]
tar形式で保存されたcmdboxサーバーのイメージをロードします。
- Parameters:
logger (logging.Logger) -- ロガー
compose_path (str) -- docker-compose.ymlファイルパス
container (str) -- コンテナ名
install_tag (str) -- インストールタグ
file (str) -- ロードするtarファイルパス
- Returns:
処理結果
- Return type:
dict
- logs(logger: Logger, compose_path: str = None, container: str = None, follow: bool = False, number: int = 20) Dict[str, Any][source]
cmdboxサーバーのログを表示します。
- Parameters:
logger (logging.Logger) -- ロガー
compose_path (str) -- docker-compose.ymlファイルパス
container (str) -- コンテナ名
follow (bool) -- ログ出力をフォローするかどうか
number (int) -- ログの最後から指定行数出力する
- Returns:
処理結果
- Return type:
dict
- make_compose_default(logger: Logger, compose_path: str, container: str, imgname: str) tuple[Dict[str, Any], Path][source]
デフォルトのdocker-compose.ymlを作成します。
- Parameters:
logger (logging.Logger) -- ロガー
compose_path (str) -- docker-compose.ymlファイルパス
container (str) -- コンテナ名
imgname (str) -- イメージ名
- Returns:
composeファイルの内容 Path: compose_path
- Return type:
dict
- make_compose_pgsql(logger: Logger, compose_path: str, container: str, imgname: str, install_pgsqlver: str) tuple[Dict[str, Any], Path][source]
pgsql用のdocker-compose.ymlを作成します。
- Parameters:
logger (logging.Logger) -- ロガー
compose_path (str) -- docker-compose.ymlファイルパス
container (str) -- コンテナ名
imgname (str) -- イメージ名
install_pgsqlver (str) -- インストールするPostgreSQLのバージョン
- Returns:
composeファイルの内容 Path: compose_path
- Return type:
dict
- make_compose_redis(logger: Logger, compose_path: str, container: str, imgname: str) tuple[Dict[str, Any], Path][source]
redis用のdocker-compose.ymlを作成します。
- Parameters:
logger (logging.Logger) -- ロガー
compose_path (str) -- docker-compose.ymlファイルパス
container (str) -- コンテナ名
imgname (str) -- イメージ名
- Returns:
composeファイルの内容 Path: compose_path
- Return type:
dict
- make_compose_server(logger: Logger, compose_path: str, container: str, imgname: str, user: str, data: str, start_sh_tgt: str, install_use_gpu: bool, install_tag: str, language: str) tuple[Dict[str, Any], Path][source]
server用のdocker-compose.ymlを作成します。
- Parameters:
logger (logging.Logger) -- ロガー
compose_path (str) -- docker-compose.ymlファイルパス
container (str) -- コンテナ名
imgname (str) -- イメージ名
user (str) -- ホストのユーザー名
data (str) -- ホストのデータ保存先ディレクトリパス
start_sh_tgt (str) -- コンテナ内のstart.shのパス
install_use_gpu (bool) -- GPUを使用してインストールするかどうか
install_tag (str) -- インストールタグ
language (str) -- 言語
- Returns:
composeファイルの内容 Path: compose_path
- Return type:
dict
- reboot(logger: Logger, args: Namespace, container: str, tm: float = 0.0, pf: List = []) Dict[str, Any][source]
コンテナを再起動します。
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List) -- 呼出元のパフォーマンス情報
- Returns:
処理結果
- Return type:
dict
- save(logger: Logger, compose_path: str = None, container: str = None, install_tag: str = None, file: str = None) Dict[str, Any][source]
cmdboxサーバーのイメージをtar形式で保存します。
- Parameters:
logger (logging.Logger) -- ロガー
compose_path (str) -- docker-compose.ymlファイルパス
container (str) -- コンテナ名
install_tag (str) -- インストールタグ
file (str) -- 保存先ファイルパス
- Returns:
処理結果
- Return type:
dict