Skip to content

Commit

Permalink
[docs] Update README and www sources to remove hab-bpm references.
Browse files Browse the repository at this point in the history
Signed-off-by: Fletcher Nichol <[email protected]>

Pull request: #556
Approved by: reset
  • Loading branch information
fnichol authored and thesentinels committed May 24, 2016
1 parent 422237e commit d522c57
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 46 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,25 +246,28 @@ $ build plans/redis
To upload the resulting package

```bash
$ hab-studio enter
$ hab-bpm install core/hab
$ hab-bpm exec core/hab hab artifact upload /hab/cache/artifacts/<PKG>.hart
$ hab artifact upload ./results/<PKG>.hart
```

Alternatively, you can use the `last_build.env` metadata to fetch the full artifact name to upload:

```bash
$ hab artifact upload ./results/$(source ./results/last_build.env && echo $pkg_artifact)
```

To create a docker container of a package, either local or remote:

```bash
$ hab-studio enter
$ hab-bpm install core/hab-pkg-dockerize
$ hab-bpm exec core/hab-pkg-dockerize hab-pkg-dockerize core/redis
$ hab install core/hab-pkg-dockerize
$ hab pkg exec core/hab-pkg-dockerize hab-pkg-dockerize core/redis
```

To develop Habitat itself, just work like you always did. If you want to,
for example, test that Redis is working with your development version of
the supervisor:

```bash
$ hab-bpm install core/redis
$ ./target/debug/hab-sup start core/redis
```

Expand Down
35 changes: 0 additions & 35 deletions www/source/docs/Reference/habitat-cli.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ The commands and sub-commands for the Habitat CLI tools are listed below:

- [hab](#hab)
- [hab-artifact](#hab-artifact)
- [hab-bpm](#hab-bpm)
- [hab-depot](#hab-depot)
- [hab-origin](#hab-origin)
- [hab-pkg](#hab-pkg)
Expand Down Expand Up @@ -68,40 +67,6 @@ Subcommand used for signing and uploading packages.

***

## hab-bpm
Package manager for Habitat. Mostly used to download and install packages.

**USAGE**

$program [COMMON_FLAGS] <SUBCOMMAND> [ARG ..]

**COMMON FLAGS**

-h Prints this message
-q Prints less output for better use in scripts
-v Prints more verbose output
-V Prints version information

**SUBCOMMANDS**

binlink Creates a symlink for a package binary in a common 'PATH' location
exec Executes a command using the 'PATH' context of an installed package
help Prints this message
install Installs a package
pkgpath Prints the path to a package
version Prints version information

**ENVIRONMENT VARIABLES**

QUIET Prints less output (\`-q' flag takes precedence)
VERBOSE Prints more verbose output (\`-v' flag takes precedence)

**SUBCOMMAND HELP**

$program <SUBCOMMAND> -h

***

## hab-config
Subcommand for applying configuration changes to a service group.

Expand Down
6 changes: 3 additions & 3 deletions www/source/docs/run-services.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ This topic describes how to create a Docker container for any artifact in the pu

1. Open the dev shell container and enter the studio with the `hab-studio enter` command.
2. Change directory to the `/src/plans` directory.
3. For any built artifacts that you want to create a Docker image from, run `hab-bpm install core/hab-pkg-dockerize` to unpack and install the artifact that creates docker images for other Habitat artifacts.
4. Run `hab-bpm exec core/hab-pkg-dockerize hab-pkg-dockerize origin/packagename` with the origin and name of your artifact. These values are referenced in the pkg_origin and pkg_name settings of your plan, respectively.
3. For any built artifacts that you want to create a Docker image from, run `hab install core/hab-pkg-dockerize` to unpack and install the artifact that creates docker images for other Habitat artifacts.
4. Run `hab pkg exec core/hab-pkg-dockerize hab-pkg-dockerize origin/packagename` with the origin and name of your artifact. These values are referenced in the pkg_origin and pkg_name settings of your plan, respectively.

22][default:/src:1]$hab-bpm exec core/hab-pkg-dockerize hab-pkg-dockerize origin/packagename
22][default:/src:1]$hab pkg exec core/hab-pkg-dockerize hab-pkg-dockerize origin/packagename

Habitat will proceed to unpack and install all necessary Habitat artifacts, the Habitat command-line interface (CLI) tools and binaries, the mytutorialapp artifact, and all of its dependencies. Then it will create an image using the Docker scratch image as the base image and build up the rest of the image from there.

Expand Down
4 changes: 2 additions & 2 deletions www/source/tutorials/getting-started-process-build.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ To show the portability of Habitat, you will export and run a Habitat service fr

[17][default:/src/plans:0]$hab install core/hab-pkg-dockerize

5. Run `hab-bpm exec core/hab-pkg-dockerize hab-pkg-dockerize origin/packagename` with the origin and name of your artifact. These values are referenced in the pkg_origin and pkg_name settings of your plan, respectively.
5. Run `hab pkg exec core/hab-pkg-dockerize hab-pkg-dockerize origin/packagename` with the origin and name of your artifact. These values are referenced in the pkg_origin and pkg_name settings of your plan, respectively.

[18][default:/src:0]$hab-bpm exec core/hab-pkg-dockerize hab-pkg-dockerize myorigin/mytutorialapp
[18][default:/src:0]$hab pkg exec core/hab-pkg-dockerize hab-pkg-dockerize myorigin/mytutorialapp

Habitat will proceed to unpack and install all necessary Habitat artifacts, the Habitat command-line interface (CLI) tools and binaries, the mytutorialapp artifact, and all of its dependencies. Then it will create an image using the Docker scratch image as the base image and build up the rest of the image from there.

Expand Down

0 comments on commit d522c57

Please sign in to comment.