Skip to main content

Configure Container Engine Network Subnet

Overview​

This document explains how to configure your Appcircle server's and Appcircle DMZ server's network subnet of the containers if the existing subnet is conflicting with other networks or not suitable for your use case.

info

This feature is included in the Appcircle server package version 3.28.0 or later.

Configuring the Subnet for Appcircle Server​

To configure the network subnet of the containers of the Appcircle server, follow these steps:

caution

Be aware that this process will cause downtime since it requires a restart of the Appcircle server.

  1. Log in to your Appcircle server via SSH or a remote connection.

  2. Change to the directory containing the Appcircle server configuration.

    cd appcircle-server

  3. Open the global.yaml file in a text editor.

    info

    The spacetech in the example codes below are example project name.

    Please find your own project name and replace spacetech with your project name.

    To see projects, you can check the projects directory.

    ls -l ./projects
    vi ./projects/spacetech/global.yaml

  4. Create or update the networkSettings entry in the global.yaml configuration file.

    caution

    If the networkSettings entry already exists in your global.yaml file, ensure you update the existing key instead of creating a new one.

    networkSettings:
      enabled: true
      networkSubnet: 10.0.0.0/16
    tip

    The networkSubnet will be used to configure the network subnet of the Appcircle server containers.

  5. After saving the configuration changes, restart your Appcircle server to apply the new settings.

    • Shutdown Appcircle server.
    ./ac-self-hosted.sh -n "spacetech" down
    • Apply configuration changes.
    ./ac-self-hosted.sh -n "spacetech" export
    • Boot Appcircle server.
    ./ac-self-hosted.sh -n "spacetech" up
    tip

    You should check the status of the Appcircle server after boot for any possible errors.

    ./ac-self-hosted.sh -n "spacetech" check

Configuring the Subnet for Appcircle DMZ Server​

To configure the network subnet of the containers of the DMZ server, follow these steps:

caution

Be aware that this process will cause downtime since it requires a restart of the Appcircle DMZ server.

  1. Log in to your Appcircle server via SSH or a remote connection.

  2. Change to the directory containing the Appcircle server configuration.

    cd appcircle-server

  3. Open the global.yaml file in a text editor.

    info

    The spacetech in the example codes below are example project name.

    Please find your own project name and replace spacetech with your project name.

    To see projects, you can check the projects directory.

    ls -l ./projects
    vi ./projects/spacetech/global.yaml

  4. Create or update the dmzNetworkSettings entry in the global.yaml configuration file.

    caution

    If the dmzNetworkSettings entry already exists in your global.yaml file, ensure you update the existing key instead of creating a new one.

    dmzNetworkSettings:
      enabled: true
      networkSubnet: 10.0.0.0/16
    tip

    The networkSubnet will be used to configure the network subnet of the Appcircle DMZ server containers.

    info

    Although the Appcircle server and Appcircle DMZ server have the same subnet configuration as the sample above, they are not required to have the same subnet values or to be configured to custom subnet both.

  5. Apply the new configuration changes.

    ./ac-self-hosted.sh -n spacetech export --dmz

  6. Compress the Appcircle DMZ server directory into a tarball.

    tar -czf dmz.tar.gz -C projects/spacetech/export/dmz/ .

  7. Transfer the dmz.tar.gz file to the Appcircle DMZ server with a file transfer protocol like scp or ftp.

  8. Log in to your Appcircle DMZ server via SSH or a remote connection.

  9. Change to the directory containing the Appcircle DMZ server configuration.

    cd appcircle-server-dmz

  10. Stop the Appcircle DMZ server.

    ./ac-self-hosted-dmz.sh down

  11. Delete the old Appcircle DMZ server directory.

    cd .. && rm -rf appcircle-dmz-server

  12. Extract the dmz.tar.gz file into a new Appcircle DMZ server directory.

    mkdir -p appcircle-server-dmz && \
    tar -xzf dmz.tar.gz -C appcircle-server-dmz

  13. Change directory into the new directory.

    cd appcircle-server-dmz

  14. Reconfigure the Appcircle DMZ server.

    ./ac-self-hosted-dmz.sh -i

  15. Start the Appcircle DMZ server.

    ./ac-self-hosted-dmz.sh up

  16. Check the Appcircle DMZ server status.

    ./ac-self-hosted-dmz.sh check

Disabling Custom Subnet Configuration​

To allow Docker or Podman to automatically manage subnet configurations for your Appcircle server and/or Appcircle DMZ server containers, you can disable the custom subnet settings.

To disable custom subnet configuration:

  1. Follow the steps in either:

  2. Set the enabled parameter to false or delete the networkSettings or dmzNetworkSettings entry in the appropriate configuration section:

    • For the Appcircle server:

      networkSettings:
        enabled: false

    • For the Appcircle DMZ server:

      dmzNetworkSettings:
        enabled: false

  3. After saving the configuration changes, restart the Appcircle server and/or Appcircle DMZ server to apply the new settings by following the steps in the Configuring the Subnet for Appcircle Server or Configuring the Subnet for Appcircle DMZ Server section.

Need help?​

Get help from Appcircle's support team, or see how others are using Appcircle by joining our Slack Channel.

Slack
No description available
join.slack.com
Preview of Slack