Uploaded image for project: 'MicroShift'
  1. MicroShift
  2. USHIFT-4086

Include a feature complete kickstart in Installation Documentation

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Duplicate
    • Icon: Undefined Undefined
    • None
    • None
    • Documentation
    • None
    • Quality / Stability / Reliability
    • False
    • Hide

      None

      Show
      None
    • None
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      Description of problem:

      The installation documentation looks like it is intending to provide a step-by-step e2e experience of provisioning your first Microshift device from an image. Unfortunately the included kickstart example has a number of issues that make it challenging for users new to image composer to be successful.
      
      These challenges include:
      
      a. The kickstart is separated into parts, a snippet followed by a post section. This should be presented as a single file so it's clear to the user that this is a single file. If the docs want to break it down into sections after that it can then do so.
      
      b. The example kickstart does not initialize the network stack which means once it is provisioned the user has no way to access MicroShift or the device itself. In my updated kickstart I provisioned it for DHCP which I feel like is a reasonable starting point:
      
      network --bootproto=dhcp --device=link --activate --onboot=on
      
      c. The Kickstart shows where to insert an encrypted password but provides no docs or links to docs on how to create the password.
      
      d. I would also recommend adding a snippet at the end of the post example to make KUBECONFIG available to the root user:
      
      # Make the KUBECONFIG from MicroShift directly available for the root user, i.e.
      
      echo -e 'export KUBECONFIG=/var/lib/microshift/resources/kubeadmin/kubeconfig' >> /root/.profile

       

      Version-Release number of selected component (if applicable):

      4.16

      How reproducible:

       

      Steps to Reproduce:

      1.
      2.
      3.
      

      Actual results:

       

      Expected results:

       

      Additional info:

       

              rhn-support-shdiaz Shauna Diaz
              gnunn@redhat.com Gerald Nunn
              None
              None
              None
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: