Details

    • Type: Bug
    • Status: Resolved
    • Priority: Medium
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: docs
    • Labels:
    • Story Points:
      1

      Description

      Source: https://docs.d2iq.com/ksphere/kommander/latest/quick-start

      Some notes that I found:

      1st graph
      Kommander is tool that provides a command console for deploying, monitoring and managing production-ready Kubernetes clusters on an enterprise scale. Kommander supports both Konvoy and non-Konvoy clusters.

      _Should be (should say `is a tool`, and we should be consistent about Oxford commas. So, I'm just adding them here): _
      Kommander is a tool that provides a command console for deploying, monitoring, and managing production-ready Kubernetes clusters on an enterprise scale. Kommander supports both Konvoy and non-Konvoy clusters.

      ###
      In the first command, it assumes the name of the file that it likely may not be. There should be a note in there for that.
      In every place that I downloaded the file, it was not named:
      `konvoy-kommander_darwin.tar.bz2`
      That being said, maybe it is named that elsewhere...but from the trial page it is not. It's named:
      `konvoy_v1.4.2_darwin.tar`
      So, maybe instead of:
      For example, if you are installing on MacOS, download the compressed archive to the default ~/Downloads directory. Afterward, extract the tarball to your local system by running the following command:

      It could be something like:
      For example, if you are installing on MacOS, download the compressed archive to the default ~/Downloads directory. Afterward, extract the tarball to your local system by running the following command (make sure to double check the name of the file that you downloaded):
      tar -xf ~/Downloads/konvoy-kommander_darwin.tar.bz2

      ###
      This part is a little off
      Copy the Konvoy package files to a directory in your user's PATH to ensure you can invoke the konvoy command from any directory.
      For example, copy the package to /usr/local/bin/ by running the following command:
      `sudo cp ~/Downloads/darwin/konvoy-kommander.tar.bz2/* /usr/local/bin/`

      You copy the Konvoy files from the unpacked directory - and that's when you get things like `konvoy --version` to work.

      So, the above should probably be changed to something like:

      Copy the Konvoy package files to a directory in your user's PATH to ensure you can invoke the konvoy command from any directory.
      For example, copy the package to /usr/local/bin/ by return to the directory that Kommander was extracted to, and running the following command:
      `sudo cp ~konvoy_v1.4.1/* /usr/local/bin/`

      NOTE: The extracted folder may have a different name (like konvoy_dev, or if it was given a custom directory, or whatever version it may be on)

      ###

      After you check the version and all that (that works after you copy those files to the PATH), you will also need to set up your MAWS locally, and get your aws credentials. I feel like this step was intentionally left out, because ... what if someone doesn't use AWS, like they do things locally, or they do things with GCP or Azure, or they run something locally, or something not in the cloud.
      So, if a user just runs `konvoy up` at this step, it creates a `cluster.yaml`, so a user can edit that now and add in whatever settings they need (if it's aws, azure, something different, etc.).
      BUT, for this Quick start, we can assume that they are going to be knowing what they are going to be using for their provider, so we may just want to say something like:
      You will have to confirm your access to your cloud or internal network provider, or you may encounter a message that says `failed to deploy the cluster: error provisioning cluster`

      ###

      Logging in with Username and Password

      We may just want to include a note about how the username and password are randomly generated here.
      So, instead of this:
      After you provision your first Konvoy cluster, your username, password, and a URL to Konvoy will be printed to the command-line.
      So, just add this clarifying thing:
      After you provision your first Konvoy cluster, your randomly-generated username, password, and a URL to Konvoy will be printed to the command-line.

      It doesn't say Beta any more, so maybe update this:
      Once in Konvoy, you should see a button labelled "Try Kommander Beta!". If not, check to ensure you've installed the Konvoy release that includes Kommander.
      To this:
      Once in Konvoy, you should see a button labelled "Try Kommander". If not, check to ensure you've installed the Konvoy release that includes Kommander.

      Updated graphic:
      https://drive.google.com/file/d/1-lnk7HSKP6DGNOmdI0y3h8rhx8jQcMwP/view?usp=sharing

        Attachments

          Activity

            People

            • Assignee:
              mattdolbey Matt Dolbey
              Reporter:
              mattdolbey Matt Dolbey
              Team:
              Doc Team
              Watchers:
              Matt Dolbey
            • Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Zendesk Support

                  NextupJiraPlusStatus

                  Error rendering 'slack.nextup.jira:nextup-jira-plus-status'. Please contact your JIRA administrators.