Uploaded image for project: 'Ignite'
  1. Ignite
  2. IGNITE-20156

Fix public documentation for running Ignite using Docker

    XMLWordPrintableJSON

Details

    • Task
    • Status: Open
    • Major
    • Resolution: Unresolved
    • None
    • None
    • documentation
    • Docs Required, Release Notes Required

    Description

      Current documentation in "Installing Using Docker" chapter has several issues which could prevent users from successfully running Ignite on Docker environment.
      1. Example for docker-compose file is incorrect. The correct one is:

      # 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.
      
      version: "3.9"
      
      name: ignite3
      
      x-ignite-def: 
        &ignite-def
        image: apacheignite/ignite3:${IGNITE3_VERSION:-latest}
        volumes: 
          - ./cluster.conf:/opt/ignite/etc/ignite-config.conf
      
      services: 
        node1:
          << : *ignite-def
          command: --node-name node1
          ports: 
            - 10300:10300
            - 10800:10800
        node2:
          << : *ignite-def
          command: --node-name node2
          ports: 
            - 10301:10300
            - 10801:10800
        node3:
          << : *ignite-def
          command: --node-name node3
          ports: 
            - 10302:10300
            - 10802:10800
      

      2. Example of command for single-node configuration is incorrect. Correct one is:

      docker run -it --rm -p 10300:10300 -p 10800:10800 apacheignite/ignite3
      

      3. Also maybe it is worth to use steps from DEVNOTES.md so we can show how to run CLI using Docker as well.

      docker compose -f packaging/docker/docker-compose.yml up -d
      docker run -it --rm --net ignite3_default apacheignite/ignite3 cli
      > connect http://node1:10300
      > cluster init --cluster-name cluster --meta-storage-node node1 --meta-storage-node node2 --meta-storage-node node3
      

      Attachments

        Issue Links

          Activity

            People

              Unassigned Unassigned
              ivan.zlenko Ivan Zlenko
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated: