HUAWEI CLOUDクラウドサーバーの評価｜Porttainerを使ったshowdocドキュメントツールの導入

I.はじめに

1.1 Yunyao Cloud Server L インスタンスの概要

Yunyao クラウド サーバー L インスタンスは、中小企業や開発者向けに特別に設計された新世代の軽量アプリケーション クラウド サーバーで、すぐに使える利便性を提供します。Yunyao クラウド サーバー L インスタンスは、ワンクリックでアプリケーションをデプロイできる、厳選された豊富なアプリケーション イメージを提供します。これにより、顧客が電子商取引 Web サイト、Web アプリケーション、小規模プログラム、学習環境、およびさまざまな開発およびテスト タスクを構築するプロセスが大幅に簡素化されます。クラウドのプロセスで。

1.2 showdoc ツールの概要

ShowDoc は、IT チームに最適なオンライン API ドキュメントおよび技術ドキュメント ツールです。showdoc を使用すると、マークダウン構文を使用して美しい API ドキュメント、データ ディクショナリ ドキュメント、技術ドキュメント、オンライン Excel ドキュメントなどを簡単に作成できます。

1.3 Porttainer ツールの紹介

Porttainer は、Web インターフェイスを通じて単一の Docker ホストまたは Swarm クラスターを管理できる軽量の Docker 管理ツールです。ユーザーが Docker コンテナー、イメージ、ネットワーク、ボリュームなどのリソースを管理するための直感的なユーザー インターフェイスを提供します。Porttainer は、コンテナーへのアクセス、終了、ログ表示、コンテナー コンソールへのアクセスもサポートしています。同時に、Porttainer は、ユーザーとチームの管理、LDAP 認証、マルチホスト管理などの高度な機能も提供します。つまり、Porttainer の登場により、Docker 管理のためのシンプルで使いやすい統合ソリューションが提供されます。

2. この実践の概要

2.1 この実践の概要

1. この演習は個人的なテストおよび学習環境であり、アプリケーションを迅速にデプロイするように設計されています。運用環境では注意してください; 2.
この演習環境は Yunyao Cloud Server L インスタンスです;
3. 今回は Yunyao Cloud Server のアプリケーション イメージを使用しますL インスタンス Porttainer 2.18.4 です;
4. この実践の前提は、Yunyao Cloud サーバー L インスタンスが購入されており、Porttainer が初期化および構成されているということです;
5. Porttainer プラットフォームに showdoc ドキュメント ツールをデプロイします。

2.2 この環境計画について

サーバークラス	イントラネットIPアドレス	Docker のバージョン	ポーターバージョン	ショードキュメントのバージョン
Yunyao クラウド サーバー L インスタンス	192.168.0.168	24.0.4	2.18.4	オープンソース バージョン showdoc v3.2.2

3. リモート接続サーバー

3.1 Yunyao Cloud Server L インスタンスのステータスを確認する

• Yunyao Cloud Server L インスタンスのステータスを確認する

• Elastic パブリック IP アドレスをコピーします。

3.2 リモートログインサーバー

ローカル コンソールを使用してログインするには、[リモート ログイン] をクリックします。

3.3 Xshell ツールがサーバーに接続する

Xshell ツールで、サーバーの Elastic Public Network IP アドレス、アカウント、パスワード情報を入力し、ssh を使用してリモート サーバーに接続します。

3.4 オペレーティング システムのバージョンを確認する

• オペレーティング システムのバージョン、使用されている ubuntu オペレーティング システムを確認します。

root@hcss-ecs-f91c:~# cat /etc/os-release
PRETTY_NAME="Ubuntu 22.04.1 LTS"
NAME="Ubuntu"
VERSION_ID="22.04"
VERSION="22.04.1 LTS (Jammy Jellyfish)"
VERSION_CODENAME=jammy
ID=ubuntu
ID_LIKE=debian
HOME_URL="https://www.ubuntu.com/"
SUPPORT_URL="https://help.ubuntu.com/"
BUG_REPORT_URL="https://bugs.launchpad.net/ubuntu/"
PRIVACY_POLICY_URL="https://www.ubuntu.com/legal/terms-and-policies/privacy-policy"
UBUNTU_CODENAME=jammy

• システムのカーネルバージョンを確認する

root@hcss-ecs-f91c:~# uname -r
5.15.0-60-generic

3.5 Docker環境を確認する

• Dockerのバージョンを確認する

root@hcss-ecs-f91c:~# docker -v
Docker version 24.0.4, build 3713ee1

• Dockerサービスのステータスを確認する

root@hcss-ecs-f91c:~# systemctl status docker
● docker.service - Docker Application Container Engine
     Loaded: loaded (/lib/systemd/system/docker.service; enabled; vendor preset: enabled)
     Active: active (running) since Tue 2023-09-05 21:51:04 CST; 13h ago
TriggeredBy: ● docker.socket
       Docs: https://docs.docker.com
   Main PID: 1061 (dockerd)
      Tasks: 73
     Memory: 187.2M
        CPU: 33.285s
     CGroup: /system.slice/docker.service

• Docker Compose のバージョンを確認する

root@hcss-ecs-f91c:~# docker compose version
Docker Compose version v2.19.1

4. showdoc ドキュメント ツールをデプロイします。

4.1 マウントディレクトリの作成

• マウントディレクトリを作成する

 mkdir -p /data/showdoc/html

• ディレクトリ認証

chmod -R 777 /data/showdoc/html

4.2 ログインポーター

Yunyao クラウド サーバー L インスタンスにログインし、Porttainer アプリケーション イメージを使用して Porttainer を自動的にインストールします。アクセス アドレスは http://elastic パブリック ネットワーク IP アドレス: 9091 です。

4.3 docker-compose.yaml ファイルを編集する

• スタック管理ページに入り、スタックを追加します。

• 以下の docker-compose.yaml ファイルをエディターにコピーします。

version: '3'
services:
  showdoc:
    image: star7th/showdoc
    container_name: showdoc
    restart: always
    user: root
    privileged: true
    ports:
      - "4999:80"
    volumes:
      - "/data/showdoc/html:/var/www/html/"
    deploy: 
      resources:
        limits:
          cpus: '2'
          memory: 2G
        reservations:
          cpus: '1'
          memory: 1G

4.4 showdoc のデプロイを開始する

デプロイ オプションをクリックして、showdoc のデプロイを開始します。

4.5 コンテナのステータスを表示する

• スタックのステータスを表示する

• コマンドラインターミナルでコンテナのステータスを確認する

root@hcss-ecs-f91c:~# docker ps
CONTAINER ID   IMAGE                           COMMAND                  CREATED              STATUS              PORTS                             NAMES
d7031080e08f   star7th/showdoc                 "/entrypoint bash do…"   About a minute ago   Up About a minute   443/tcp, 9000/tcp, 0.0.0.0:4999->80/tcp, :::4999->80/tcp                             showdoc

5、showdoc初期化設定

5.1 セキュリティグループのポート設定

showdoc サービスの外部アクセス用にマップされたポートは 4999 で、セキュリティ グループの受信方向のポート 4999 が許可されます。

5.2 showdoc 初期化設定ページに入る

アドレス: http://elastic public network IP address: 4999 にアクセスし
、IP アドレスを自分のサーバーの Elastic Public Network IP アドレスに置き換えます。

5.3 システム言語の設定

言語を中国語として選択してください

5.4 showdoc ホームページに入る

クリックしてホームページに入り、自動的に showdoc ホームページにジャンプします。

6、showdocの基本的な使い方

6.1 ログイン showdoc

ログイン オプションをクリックします。デフォルトのアカウント パスワードは showdoc/123456 です。

6.2 経営背景へのアクセス

「背景の管理」をクリックして、背景管理ページに入ります。

6.3 新しいプロジェクトの作成

「新規プロジェクトの作成」をクリックし、プロジェクト名などを入力します。

6.4 新しいドキュメントの作成

• 新しく作成したプロジェクト「my-project」をクリックします。

• 新しいディレクトリ

• ページの追加を選択します

• ドキュメントのタイトルとドキュメントのコンテンツを編集します。ここで、書き終えたブログ投稿をテキスト エディタにコピーします。右側にプレビュー効果が表示され、ドキュメントを保存します。

6.5 ドキュメントの内容を表示する

編集したばかりのドキュメントのコンテンツを表示する

6.6 ドキュメントの共有

ドキュメント共有を選択し、共有リンクをブラウザにコピーして開きます。

7. まとめ

この実践「HUAWEI CLOUD クラウドサーバーの評価｜Porttainer を使用した Showdoc Documentation Tool の展開」は正常に完了しました。展開プロセス中、操作はスムーズで、遅延はありませんでした。セキュリティ グループのサービス ポートは、リリースされ、アプリケーション コンテナが正常に起動するかどうかを確認する必要があります。全体的なユーザー エクスペリエンスは良好で、Yunyao クラウド サーバー L インスタンスは個人にとって本当に信頼できる便利なヘルパーです。