Git Product home page Git Product logo

Comments (2)

JakeQuilty avatar JakeQuilty commented on June 2, 2024

Suggested Changes

  • Put at beginning of tutorial:
For the initial set up of the environment, we will be executing our commands in the Docker containers using <code data-lang="shell">docker-compose exec <CONTAINER NAME> <COMMANDS></code>. This enables us to execute commands in multiple containers without leaving our local session. At any point during the tutorial, you may choose to open a shell on the container to run the commands directly. See <a href="https://www.conjur.org/get-started/quick-start/run-demo-app/#step-1">Unit 4: Step 1</a> for an example.
  • Edit to Unit 1:Step 4(Verification):
    • The rest of the tutorial uses docker-compose
    • Also, this will display all the containers on the machine and we just want to maker sure our containers for the tutorial are running
docker-compose ps
  • Edit to Unit 2:Step 2

    • Conjur generates the following API keys and stores them in a file, my_app_data: should changed for consitency with the rest of the tutorial to:
Conjur generates the following API keys and stores them in a file, <strong>my_app_data</strong>:
  • Edit to Unit 4:Step 1:
    • The rest of the tutorial uses docker-compose, so this should be changed for consistency to:
docker-compose exec bot_app bash
  • Add to Unit 4:Step 2:
    • I've seen a few people get caught up on this step(including myself) on their first run through.
<strong>Make sure to replace <code><BotApp Api Key></code> with the API key stored in my_app_data.</strong>

Topics for Discussion

  • I think the user in this Commons post may have actually been onto something. Every step from Unit 1:Step 5 to Unit 4:Step 1 is executed in the conjur container. It may clean up the command if we just add a step to docker-compose exec conjur bash at the end of Unit 1 and have the user stay in that container until Unit 4. Then just have them switch into the bot_app container then. I'm not sure if this is best practice to keep opening shells in your different containers to run the commands, but we'd be able to take off the docker-compose exec client from most of the commands in the tutorial. I was a little confused by this when I first ran through the tutorial, because I was unfamiliar with Docker.

  • In Unit 4 it would be nice if there was an explanation of what is happening when you run program.sh

from conjur-quickstart.

alexkalish avatar alexkalish commented on June 2, 2024

I have an additional change to request. After some research, with @h-artzi's help, we realized that OSS doesn't have a master key. Just a data key. The Quick Start needs to be updated to remove the "master" descriptor from this key name, in the following step:
image
Essentially, every reference to "master key" or "master data key" need to be replaced with just "data key". Thanks!

from conjur-quickstart.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.