Skip to content

Commit 0423dcc

Browse files
authored
Merge pull request #9686 from habitat-sh/im/origins
Update docs about creating origins
2 parents 8cef981 + 96a64b5 commit 0423dcc

6 files changed

Lines changed: 139 additions & 129 deletions

File tree

components/docs-chef-io/content/habitat/builder_origins.md

Lines changed: 81 additions & 90 deletions
Large diffs are not rendered by default.

components/docs-chef-io/content/habitat/get_started.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
+++
22
title = "Get Started with Chef Habitat"
33
gh_repo = "habitat"
4+
draft = true
45

56
[menu]
67
[menu.habitat]
@@ -134,7 +135,7 @@ Use the Habitat Studio to generate a Habitat package and preview the running Nod
134135

135136
## Manage the Service with Habitat Builder
136137

137-
[Chef Habitat Builder]({{< relref "/habitat/builder_overview" >}}) acts as the core of Chefs Application Delivery Enterprise hub. The Chef Habitat Builder SaaS stores plan files where they can be viewed and accessed by the Chef Habitat community and then deployed by the Chef Habitat Supervisor.
138+
[Chef Habitat Builder]({{< relref "/habitat/builder_overview" >}}) acts as the core of Chef's Application Delivery Enterprise hub. The Chef Habitat Builder SaaS stores plan files where they can be viewed and accessed by the Chef Habitat community and then deployed by the Chef Habitat Supervisor.
138139

139140
Add your package to your Builder origin and then connect that package to your clone of the sample-node-app repository. Any changes made to your clone of the sample-node-app will trigger the Chef Habitat Builder to rebuild the package.
140141

Lines changed: 18 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,37 @@
11
+++
2-
title = "Create an Origin"
3-
description = "Create an Origin on Chef Habitat Builder"
2+
title = "Overview of Chef Habitat Builder origins"
43
gh_repo = "habitat"
54

65
[menu]
76
[menu.habitat]
8-
title = "Create an Origin"
9-
identifier = "habitat/origins Create an Origin"
7+
title = "Overview"
8+
identifier = "habitat/origins/overview"
109
parent = "habitat/origins"
1110
weight = 10
1211
+++
1312

14-
An origin is a space on Chef Habitat Builder where you can store, share, and build packages. It is a unique namespace within Chef Habitat Builder, and while you can delete or transfer an origin, you can't rename an origin after it is created. One example of an origin is the "core" origin, which is the set of foundational packages managed and versioned by the core Chef Habitat maintainers.
13+
{{< readfile file="/habitat/reusable/md/builder_origins.md" >}}
1514

16-
You can join existing origins by invitation and you can create your own origins.
17-
For more on invitations, see [origin membership and RBAC]({{< relref "origin_rbac.md#origin-membership" >}}).
15+
## Chef-owned origins
1816

19-
### Create an Origin
17+
Progress Chef maintains the following origins:
2018

21-
![Chef Habitat Builder without origins](/images/habitat/create-origin.png)
19+
- **core**: Hosts packages for common dependencies and compilers maintained by Progress Chef.
20+
- **chef**: Hosts packages for Chef products like Chef Infra Client, Chef InSpec, and Chef Automate.
21+
- **chef-platform**: Hosts packages for Chef 360 Platform skills.
22+
- **habitat**: Hosts packages required for an on-prem Habitat Builder deployment.
2223

23-
To create an origin, select the **Create origin** button on the _My Origins_ page which opens the _Create New Origin_ form. (Chef Habitat Builder > My Origins )
24+
## Where can I create an origin
2425

25-
![Creating an origin](/images/habitat/create-origin-form.png)
26+
You can create origins in an on-prem Habitat Builder deployment.
27+
[Chef's public Habitat Builder](https://bldr.habitat.sh) doesn't support creating new origins.
2628

27-
First, enter a unique name that you want to associate with your packages. Chef Habitat will only let you create an origin with a unique name. Some examples that you'll see in Chef Habitat Builder are team names, user names, and abstract concepts.
29+
## Create an origin
2830

29-
Next, choose a privacy setting to set as the default for new packages. You can override this setting when uploading individual packages from the CLI or by connecting a plan file that declares a package as private. The difference between public and private packages is:
31+
{{< readfile file="/habitat/reusable/md/create_origins_builder.md" >}}
3032

31-
- Anyone can find and use public packages
32-
- Only users with origin membership can find and use private packages
33+
### Create an origin with the Chef Habitat CLI
3334

34-
When you select **Save and Continue**, Chef Habitat Builder:
35+
{{< readfile file="/habitat/reusable/md/create_origins_cli.md" >}}
3536

36-
1. Creates your origin
37-
1. Creates an [origin key pair]({{< relref "origin_keys.md" >}})
38-
1. Redirects Chef Habitat Builder to the origin page
39-
40-
![Origin successfully created](/images/habitat/create-origin-done.png)
41-
42-
#### Create an Origin with the Chef Habitat CLI
43-
44-
Use the [hab origin]({{< relref "habitat_cli.md#hab-origin" >}}) commands to manage your origins from the command line.
45-
46-
Create an origin from the command line with the [hab origin create]({{< relref "habitat_cli.md#hab-origin-create" >}}) command
47-
48-
```bash
49-
hab origin create <origin>
50-
```
51-
52-
The results of this command differ slightly from creating an origin on the Chef Habitat Builder site. The CLI command:
53-
54-
1. Creates an origin on the Chef Habitat Builder site
55-
1. Does _not_ generate an origin key pair
56-
57-
For more information, see the [`hab origin create`]({{< relref "habitat_cli.md#hab-origin-create" >}}) CLI documentation.
37+
To create key pair for your origin, see the [origin keys]({{< relref "/habitat/origin_keys/#generate-origin-keys" >}}) documentation.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
An origin is a unique namespace in Chef Habitat Builder where you can store, share, and build packages.
2+
Once created, an origin cannot be renamed, but it can be deleted or transferred.
3+
For example, the _core_ origin contains foundational packages managed and versioned by the core Chef Habitat maintainers.
4+
5+
You can join existing origins by invitation or create your own origins in an on-prem Habitat Builder deployment. For details about invitations, see [origin membership and RBAC]({{< relref "origin_rbac.md#origin-membership" >}}).
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
2+
To create an origin in Chef Habitat Builder, follow these steps:
3+
4+
1. In Habitat Builder, select **My Origins** in the left navigation menu.
5+
6+
1. On the **My Origins** page, select **Create origin** which opens the **Create New Origin** form.
7+
8+
1. Enter a unique name that you want to associate with your packages. Chef Habitat will only let you create an origin with a unique name. Some examples that you'll see in Chef Habitat Builder are team names, user names, and abstract concepts.
9+
10+
1. Choose a privacy setting to set as the default for new packages. You can override this setting when uploading individual packages from the CLI or by connecting a plan file that declares a package as private.
11+
12+
The difference between public and private packages is:
13+
14+
- Anyone can find and use public packages.
15+
- Only users with origin membership can find and use private packages.
16+
17+
1. Select **Save and Continue**
18+
19+
Habitat Builder does the following:
20+
21+
- Creates your origin.
22+
- Creates an [origin key pair]({{< relref "/habitat/origin_keys" >}}).
23+
- Redirects Chef Habitat Builder to the origin page.
24+
25+
![Origin successfully created](/images/habitat/create-origin-done.png)
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
2+
To create an origin with the hab CLI, use the [`hab origin create`]({{< relref "habitat_cli.md#hab-origin-create" >}}) command. For example:
3+
4+
- ```bash
5+
hab origin create <ORIGIN>
6+
```
7+
8+
Habitat creates an origin on the Chef Habitat Builder site.

0 commit comments

Comments
 (0)