Skip to content

CDK-886: Add instructions for replacing kite-dataset in /usr/bin #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

CDK-886: Add instructions for replacing kite-dataset in /usr/bin #76

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2c4f68e
Per CDK-886, add instructions for replacing kite-dataset in /usr/bin
Feb 23, 2015
9784cd0
Updates based on comments 2/23.
Feb 24, 2015
d84b15c
Updates based on feedback 3/5/2015.
Mar 5, 2015
264c770
Changed path to /usr/lib/kite/bin/ for packages.
Mar 5, 2015
3009b08
Update Install-Kite.md
Mar 28, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion Install-Kite.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,22 @@ curl http://central.maven.org/maven2/org/kitesdk/kite-tools/{{site.version}}/kit
chmod +x {{site.dataset-command}}
```

The first command downloads the Kite tools JAR to a local file named _{{site.dataset-command}}_. The second changes the access rights on the JAR so that the classes in the JAR are executable.
The first command downloads the Kite tools JAR to a local file named `{{site.dataset-command}}`. The second changes the access rights on the JAR so that the classes in the JAR are executable.

Some versions of CDH come with `{{site.dataset-command}}` installed. However, it might not be the latest version. To check the version, from a terminal window, enter the following command.
Copy link
Contributor

@rdblue rdblue Mar 5, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should start a new section so readers have an obvious choice between installing or replacing an existing command.

Copy link
Contributor Author

@DennisDawson DennisDawson Mar 5, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, okay. The reason I hesitate to do that is that I'm pretty sure everyone will always need to do something in order to use the latest version of the software. I'll add the heading "Verifying the Version In Use," which will hopefully get them to keep reading.


```
{{site.dataset-command}} --version
```

If the version number doesn't match the version you downloaded, you have two options.
Copy link
Contributor

@rdblue rdblue Mar 5, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These instructions download a specific version, so you can just state the version here. There's a chance that the user is reading an old version of this guide, so it is also a good time to point them at the latest, which is always at /docs/current/Install-Kite.html

Copy link
Contributor Author

@DennisDawson DennisDawson Mar 28, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doesn't make sense to me in this context. These instructions are for verifying that the version installed is the version in use.


1. Include the path to `{{site.dataset-command}}` when you invoke commands. For example, if the JAR file is in the current directory, use `./{{site.dataset-command}}`.

1. Replace the installed version of `{{site.dataset-command}}`.
a. Download `{{site.dataset-command}}` (in this example, it is downloaded to the `~/` directory).
b. Replace the old version of `{{site.dataset-command}}` in the existing location.
1. For packages, use `sudo cp ~/{{site.dataset-command}} /usr/bin/{{site.dataset-command}}`.
Copy link
Contributor

@rdblue rdblue Mar 5, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For packages the path is /usr/lib/kite/bin/{{site.dataset-command}}

Copy link
Contributor Author

@DennisDawson DennisDawson Mar 5, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Working in the 5.2 VM, it seems that /usr/lib/kite/bin/ is not in the $PATH statement. Replacing that instance of kite-dataset doesn't make a difference, but replacing the one in /usr/bin does. Not sure how you want to resolve that.

Copy link
Contributor

@rdblue rdblue Mar 5, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The file in /usr/bin initializes the java environment and then calls the one in /usr/lib/kite/bin. Replacing the one in the Kite install ensures that package updates work and that the java environment is correct. Otherwise there are more issues.

Copy link
Contributor Author

@DennisDawson DennisDawson Mar 5, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ach - got it. I was working in a 5.2 VM where I'd changed the /usr/bin instance, which you informed me is only supposed to be a pointer to the one in /usr/lib/kite/bin.

Copy link
Contributor Author

@DennisDawson DennisDawson Mar 6, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question, though: is it a good practice to give the same name to the pointer JAR and the kite-dataset JAR? Could the one in /usr/bin be named kite, for example, to distinguish from the one with the goodies inside?

Copy link
Contributor

@rdblue rdblue Mar 6, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They use the same name because they represent the same command. It's not really a problem and is a common pattern when relocating commands.

1. For parcels, use `sudo cp ~/{{site.dataset-command}} /opt/cloudera/parcels//lib/kite/bin/{{site.dataset-command}}`.

c. To verify that the correct version is in use, enter the command `{{site.dataset-command}} --version`.
Copy link
Contributor

@rdblue rdblue Mar 5, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is indented to with the sub-bullets under b. I'm not sure if it looks correct when rendered so you should check.

Copy link
Contributor Author

@DennisDawson DennisDawson Mar 5, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This renders correctly in Safari, which is why I did it that way. MD is not great at nested lists.

Copy link
Contributor

@rdblue rdblue Mar 5, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't really know if it does or not, but I wouldn't be surprised either way. Probably best to make sure it's fixed.

Copy link
Contributor

@rdblue rdblue Mar 23, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Indentation is off.

Copy link
Contributor

@rdblue rdblue Mar 23, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should state the expected version when the command is successful.

Copy link
Contributor Author

@DennisDawson DennisDawson Mar 27, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The indentation renders correctly in Chrome and Safari. Trying to continue the "c" indentation after the numbered indentation did not render properly when indented equal with "a" and "b". I had to play with this a bit to get it display properly. I looked for alternatives in the Markdown/Kramdown documentation, and couldn't find another solution.