From b864290cc407c85fc0cf0c8959945fc064ed45d9 Mon Sep 17 00:00:00 2001 From: Ian Maddaus Date: Fri, 23 May 2025 12:26:40 -0400 Subject: [PATCH] Update Hab docs Signed-off-by: Ian Maddaus --- .../content/habitat/builder_origins.md | 171 +++++++++--------- .../content/habitat/get_started.md | 3 +- .../docs-chef-io/content/habitat/origins.md | 56 ++---- .../habitat/reusable/md/builder_origins.md | 5 + .../reusable/md/create_origins_builder.md | 25 +++ .../habitat/reusable/md/create_origins_cli.md | 8 + _vendor/modules.txt | 2 +- go.mod | 2 +- go.sum | 4 +- 9 files changed, 143 insertions(+), 133 deletions(-) create mode 100644 _vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/reusable/md/builder_origins.md create mode 100644 _vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/reusable/md/create_origins_builder.md create mode 100644 _vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/reusable/md/create_origins_cli.md diff --git a/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/builder_origins.md b/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/builder_origins.md index 8f40911f49..a7011c0677 100644 --- a/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/builder_origins.md +++ b/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/builder_origins.md @@ -10,77 +10,68 @@ gh_repo = "habitat" parent = "habitat/builder" weight = 30 +++ -An origin is a place 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. -You can join existing origins by invitation and you can create your own origins. -For more on invitations, see [origin membership and RBAC]({{< relref "#origin-membership" >}}). +{{< readfile file="/habitat/reusable/md/builder_origins.md" >}} -## Create an Origin +## Chef-owned origins -![Chef Habitat Builder without origins](/images/habitat/create-origin.png) +Progress Chef maintains the following origins: -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 ) +- **core**: Hosts packages for common dependencies and compilers maintained by Progress Chef. +- **chef**: Hosts packages for Chef products like Chef Infra Client, Chef InSpec, and Chef Automate. +- **chef-platform**: Hosts packages for Chef 360 Platform skills. +- **habitat**: Hosts packages required for an on-prem Habitat Builder deployment. -![Creating an origin](/images/habitat/create-origin-form.png) +## Where can I create an origin -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. +You can create origins in an on-prem Habitat Builder deployment. +[Chef's public Habitat Builder](https://bldr.habitat.sh) doesn't support creating new origins. -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: +## Create an origin - - Anyone can find and use public packages - - Only users with origin membership can find and use private packages +{{< readfile file="/habitat/reusable/md/create_origins_builder.md" >}} -When you select **Save and Continue**, Chef Habitat Builder: +### Create an origin with the Chef Habitat CLI -1. Creates your origin -1. Creates an [origin key pair]({{< relref "#origin-keys" >}}) -1. Redirects Chef Habitat Builder to the origin page +{{< readfile file="/habitat/reusable/md/create_origins_cli.md" >}} -![Origin successfully created](/images/habitat/create-origin-done.png) +To create key pair for your origin, see the [origin keys](#origin-keys) documentation. -### Create an Origin with the Chef Habitat CLI +## Origin membership and role-based access control -Use the [hab origin]({{< relref "habitat_cli/#hab-origin" >}}) commands to manage your origins from the command line. - -Create an origin from the command line with the [hab origin create]({{< relref "habitat_cli/#hab-origin-create/" >}}) command - -``` -hab origin create -``` - -The results of this command differ slightly from creating an origin on the Chef Habitat Builder site. The CLI command: +Prerequisites: -1. Creates an origin on the Chef Habitat Builder site -1. Does _not_ generate an origin key pair +- [Download the Chef Habitat CLI]({{< relref "install_habitat" >}}) +- [Create a Chef Habitat Builder account]({{< relref "#builder-account" >}}) +- [Generate a personal access token]({{< relref "#builder-token" >}}) +- [Create an origin]({{< relref "#create-origin" >}}) or accept an invitation to an existing origin +- [Get origin keys]({{< relref "#origin-keys" >}}) -For more information, see the [`hab origin create`]({{< relref "habitat_cli/#hab-origin-create" >}}) CLI documentation. -## Origin Membership & RBAC +### Role-based access control (RBAC) for Chef Habitat Builder (SaaS and on-prem) -Prerequisites: +New in: 1.6.140 -* [Download the Chef Habitat CLI]({{< relref "install_habitat" >}}) -* [Create a Chef Habitat Builder account]({{< relref "#builder-account" >}}) -* [Generate a personal access token]({{< relref "#builder-token" >}}) -* [Create an origin]({{< relref "#create-origin" >}}) or accept an invitation to an existing origin -* [Get origin keys]({{< relref "#origin-keys" >}}) +Role-based access control (RBAC) provides your organization with better operational safety by letting you assign specific levels of access to each user that belongs to an origin. With RBAC in place, existing standard origin 'members' from earlier versions are assigned the 'Maintainer' role. This role has similar permissions of the previous generic 'member' role, and the areas of difference are detailed below. The origin owner role remains unchanged. +When you join or create an origin, Chef Habitat Builder identifies your personal access token and assigns it a membership role for that origin. Your membership role defines the level of access that you have to the resources in an origin. By default, you're assigned the "read-only" role when you join an origin, and you're assigned the 'owner' role when you create an origin. -### Role-Based Access Control (RBAC) for Chef Habitat Builder (SaaS and on-prem) +Chef Habitat Builder has the following RBAC origin member roles: -New in: 1.6.140 +Read-Only +: This user can read an origin's packages, channels, origin membership, jobs, keys, integrations, invitations, roles, settings but cannot add to, change, or delete anything else in the origin, including uploading packages and inviting users to the origin. Read-Only is the default membership role for users joining the origin. -RBAC provides your organization with better operational safety by letting you assign specific levels of access to each user that belongs to an origin. With RBAC in place, existing standard origin 'members' from earlier versions are assigned the 'Maintainer' role. This role has similar permissions of the previous generic 'member' role, and the areas of difference are detailed below. The origin owner role remains unchanged. +Member +: In addition to read-only access, an origin 'Member' can upload and build packages in the 'unstable' channel, but they cannot promote packages to other channels. -When you join or create an origin, Chef Habitat Builder identifies your personal access token and assigns it a membership role for that origin. Your membership role defines the level of access that you have to the resources in an origin. By default, you're assigned the "read-only" role when you join an origin, and you're assigned the 'owner' role when you create an origin. +Maintainer +: Existing origin 'members' are now 'Maintainers'. This role has full read and write access to packages, channels, origin membership, jobs, integrations, invitations, settings. However, the 'Maintainer' role is more limited than the past role, in that 'Maintainers' only have read access to packages, channels, origin membership, jobs, keys, integrations, and settings. Origin 'Maintainers' can read origin membership roles and see and send invitations, but they cannot otherwise change origin membership--their own or anybody else's. Finally, 'Maintainers' can neither read nor write origin secrets. -RBAC Origin Member Roles: +Administrator +: In addition to 'Maintainer' access, the 'Administrator' role adds the missing privileges for writing origin keys and membership roles, as well as for reading and writing origin secrets. Administrators have full read and write access to packages, channels, origin membership, jobs, keys, integrations, invitations, roles, secrets, settings. -* Read-Only: This user can read an origin's packages, channels, origin membership, jobs, keys, integrations, invitations, roles, settings but cannot add to, change, or delete anything else in the origin, including uploading packages and inviting users to the origin. Read-Only is the default membership role for users joining the origin. -* Member: In addition to read-only access, an origin 'Member' can upload and build packages in the 'unstable' channel, but they cannot promote packages to other channels. -* Maintainer: Existing origin 'members' are now 'Maintainers'. This role has full read and write access to packages, channels, origin membership, jobs, integrations, invitations, settings. However, the 'Maintainer' role is more limited than the past role, in that 'Maintainers' only have read access to packages, channels, origin membership, jobs, keys, integrations, and settings. Origin 'Maintainers' can read origin membership roles and see and send invitations, but they cannot otherwise change origin membership--their own or anybody else's. Finally, 'Maintainers' can neither read nor write origin secrets. -* Administrator: In addition to 'Maintainer' access, the 'Administrator' role adds the missing privileges for writing origin keys and membership roles, as well as for reading and writing origin secrets. Administrators have full read and write access to packages, channels, origin membership, jobs, keys, integrations, invitations, roles, secrets, settings. -* Owner: As in the past, the origin 'Owner' has full read and write access to the origin. Only Owners can delete the origin or transfer ownership to another member. +Owner +: As in the past, the origin 'Owner' has full read and write access to the origin. Only Owners can delete the origin or transfer ownership to another member. ### Comparison of RBAC Member Roles and Actions @@ -120,7 +111,7 @@ RBAC Origin Member Roles: | Transfer Origin | N | N | N | N | Y | | Delete Origin | N | N | N | N | Y | -### Manage Origin Membership +### Manage origin membership In tandem with the changes to the Builder membership roles, we've also updated the `hab` CLI to support RBAC. We're working on adding role management to the Chef Habitat Builder site, but in the meantime, you'll need to use the CLI for now. @@ -209,14 +200,14 @@ Set an origin membership RBAC role with: hab origin rbac set bluewhale admin --origin two-tier-app ``` -## Origin Keys +## Origin keys Prerequisites: -* [Download the Chef Habitat CLI]({{< relref "install_habitat" >}}) -* [Create a Chef Habitat Builder account]({{< relref "#builder-account" >}}) -* [Generate a personal access token]({{< relref "#builder-token" >}}) -* [Create an origin with `hab origin create` or join an origin by invitation]({{< relref "#create-origin" >}}) +- [Download the Chef Habitat CLI]({{< relref "install_habitat" >}}) +- [Create a Chef Habitat Builder account]({{< relref "#builder-account" >}}) +- [Generate a personal access token]({{< relref "#builder-token" >}}) +- [Create an origin with `hab origin create` or join an origin by invitation]({{< relref "#create-origin" >}}) When you create an origin, Chef Habitat Builder automatically generates _origin keys_. Origin key cryptography is asymmetric: it has a public origin key that you can distribute freely, and a private origin key that you should distribute only to users belonging to the origin. @@ -229,10 +220,10 @@ All Chef Habitat Builder users with access to the origin can view the origin pub Chef Habitat uses origin keys: -* When you build an artifact in your local environment, Chef Habitat signs the artifact with a public key -* When you upload an artifact to Chef Habitat Builder or Builder on-prem, Chef Habitat verifies that the artifact was signed with its public key -* When you install an artifact on a Chef Habitat Supervisor, Chef Habitat uses the public origin key to authorize the artifact's installation; Chef Habitat only installs artifacts for which it has the public origin key -* When you download an artifact to your local environment, Chef Habitat uses the public origin key to verify the artifact's integrity before it starts the installation +- When you build an artifact in your local environment, Chef Habitat signs the artifact with a public key +- When you upload an artifact to Chef Habitat Builder or Builder on-prem, Chef Habitat verifies that the artifact was signed with its public key +- When you install an artifact on a Chef Habitat Supervisor, Chef Habitat uses the public origin key to authorize the artifact's installation; Chef Habitat only installs artifacts for which it has the public origin key +- When you download an artifact to your local environment, Chef Habitat uses the public origin key to verify the artifact's integrity before it starts the installation Chef Habitat Builder origin key names follow the format: @@ -248,40 +239,40 @@ testorigin-20190416223046.pub testorigin-20190416223046.sig.key ``` -* "testorigin" is the origin's name -* "20190416223046" is the date and time of the key's creation, which was 2019-04-16 22:30:46. -* `.pub` is the file extension for the public key -* `.sig.key` is the file extension for the private key, which is also called a "signing key" +- "testorigin" is the origin's name +- "20190416223046" is the date and time of the key's creation, which was 2019-04-16 22:30:46. +- `.pub` is the file extension for the public key +- `.sig.key` is the file extension for the private key, which is also called a "signing key" -### The Keys Tab +### Keys tab When you create an origin, Chef Habitat Builder automatically generates an origin key pair and saves both keys. To view your origin keys on Chef Habitat Builder, navigate to your origin and select the **Keys** tab. (Builder > Origins > Keys) You will always be able to view and download origin public keys, but you will only see the private keys for origins in which you are an "administrator" or "owner". ![Viewing your origin keys](/images/habitat/origin-keys.png) -#### Download Origin Keys +#### Download origin keys Download your private or public origin key by selecting the **download** icon from the right end of the key details, under the _Actions_ heading. ![Detail of the download icon](/images/habitat/origin-key-download.png) -#### Upload Origin Keys +#### Upload origin keys You can upload origin keys that you generate on the command line to Chef Habitat Builder by selecting either the **Upload a private key** or **Upload a public key** icon, and copy your key into the form that appears. ![Example form content for uploading an origin key in Builder](/images/habitat/builder-key-upload.png) -### Managing Origin Keys with the CLI +### Managing origin keys with the CLI Run Chef Habitat CLI commands from your local environment or from within the Chef Habitat Studio. See the CLI documentation for more information on the [`hab origin key`]({{< relref "habitat_cli/#hab-origin-key" >}}) commands. -#### Find Your Local Origin Keys +#### Find your local origin keys Chef Habitat stores your public and private origin keys at `~/.hab/cache/keys` on Linux systems, `C:\hab\cache\keys` on Windows, and at `/hab/cache/keys` inside of the Chef Habitat Studio environment. -##### To find your origin keys in your local environment: +##### Find your origin keys in your local environment On Windows: @@ -295,7 +286,7 @@ On Linux or macOS: ls -la ~/.hab/cache/keys ``` -##### To find your existing origin keys from inside of the Chef Habitat Studio: +##### Find your existing origin keys from inside of the Chef Habitat Studio On Windows: @@ -309,14 +300,14 @@ On Linux or macOS: ls -la /hab/cache/keys ``` -#### Generate Origin Keys with the CLI +#### Generate origin keys with the CLI When you create an origin through the site, Chef Habitat Builder automatically generates an origin key pair. The Chef Habitat CLI creates origin key pairs through two different commands, for two different uses: -* Use [`hab setup`]({{< relref "install_habitat" >}}) to generate your first origin key pair as part of setting up the `hab` CLI -* Use the `hab origin key generate ` command to create an key pair for an origin created with the `hab origin create` command +- Use [`hab setup`]({{< relref "install_habitat" >}}) to generate your first origin key pair as part of setting up the `hab` CLI +- Use the `hab origin key generate ` command to create an key pair for an origin created with the `hab origin create` command Create origin keys with the `hab` command: @@ -324,7 +315,7 @@ Create origin keys with the `hab` command: hab origin key generate ``` -#### Download Origin Keys with the CLI +#### Download origin keys with the CLI To get your public origin key using the command line, use: @@ -332,13 +323,13 @@ To get your public origin key using the command line, use: hab origin key download ``` -#### Upload Origin Keys with the CLI +#### Upload origin keys with the CLI Creating an origin with the `hab origin create` command registers the origin on Chef Habitat Builder without creating an origin key pair. The `hab origin key generate` command creates the key pair and saves them in your local environment, but it does not upload either origin key to Chef Habitat Builder. -* Only "administrators" and "owners" can upload new keys to an origin. -* Builder requires the public origin key to upload artifacts for that origin, so you'll need to upload it. -* Builder requires the private origin key to enable new artifact builds from packages with plans linked to that origin. +- Only "administrators" and "owners" can upload new keys to an origin. +- Builder requires the public origin key to upload artifacts for that origin, so you'll need to upload it. +- Builder requires the private origin key to enable new artifact builds from packages with plans linked to that origin. Upload origin keys with the `hab` command: @@ -358,7 +349,7 @@ Upload both origin keys at the same time: hab origin key upload --secfile --pubfile ``` -#### Import Origin Keys with the CLI +#### Import origin keys with the CLI Use `hab origin key import` to read the key from a standard input stream into Chef Habitat Builder: @@ -368,7 +359,7 @@ hab origin key import curl | hab origin key import ``` -##### Troubleshoot Origin Key Import +##### Troubleshoot origin key import On a macOS, you may encounter an upload failure. To remediate this failure: @@ -387,12 +378,12 @@ Initialize the setting from the command line with: source ~/.bashrc ``` -## Origin Settings +## Origin settings -The _Origin Settings_ tab contains: +The **Origin Settings** tab contains: -* Default Package Settings -* Origin Secrets +- Default Package Settings +- Origin Secrets Everyone with origin membership can see the _Settings_ tab, but only origin administrators and owners can add, update, or delete settings content. @@ -406,27 +397,27 @@ Everyone with origin membership can see the _Settings_ tab, but only origin admi ![The administrator or owner's view of the origin settings tab with a public default package setting and a saved origin secret](/images/habitat/origin-secrets.png) -### Default Package Settings +### Default package settings The _Default Package Settings_ define the visibility of build artifacts (.hart files). Everyone with origin membership can view the origin settings, but only origin administrators and owners can add, update, or delete settings. -* Public packages are visible in search results and can be used by every Chef Habitat Builder user -* Private artifacts do not appear in search results and are available only to users with origin membership +- Public packages are visible in search results and can be used by every Chef Habitat Builder user +- Private artifacts do not appear in search results and are available only to users with origin membership Change the default setting for the origin by switching from **Public Packages** to **Private Packages**. The default setting required for each origin and users with more than one origin can set some as public and others as private. Packages can have different default visibility settings than their origin's. Change the default visibility setting in for individual packages in that package's setting tab (Builder > Origin > Package > Settings). -### Origin Secrets +### Origin secrets Everyone with origin membership can view origin secrets, but only origin administrators and owners can add, update, or delete settings. _Origin Secrets_ are located at the bottom of the _Settings_ tab (Builder > Origin > Settings > Origin Secrets) and they let you encrypt and store secrets as environment variables. Origin secrets are useful for plans that require access to protected resources at build time, such as private source-code repositories and cloud storage providers. Origin secrets are retained by the origin and are available for any of that origin's packages. The origin secrets in your local environment are encrypted with an origin encryption key. Only Chef Habitat Builder can read encrypted origin secrets. -#### Manage Origin Secrets with the Chef Habitat CLI +#### Manage origin secrets with the Chef Habitat CLI You can view the list of origin secrets and delete them in Chef Habitat Builder. However, the primary way of interacting with origin secrets is with the Chef Habitat CLI. -##### List Secrets +##### List secrets To list all of the secrets in an origin, use: @@ -434,7 +425,7 @@ To list all of the secrets in an origin, use: hab origin secret list --origin ``` -##### Set Origin Secrets as Environment Variables +##### Set origin secrets as environment variables Add your origin secrets as environment variables in your local environment: @@ -444,7 +435,7 @@ export HAB_AUTH_TOKEN= hab origin secret list ``` -##### Save an Origin Secret +##### Save an origin secret To save an origin secret give the secret a name and the key value: @@ -466,7 +457,7 @@ $ hab origin secret upload AWS_ACCESS_KEY_ID 1234567890EXAMPLE ✓ Uploaded secret for AWS_ACCESS_KEY_ID. ``` -##### Delete an Origin Secret +##### Delete an origin secret To delete an origin secret from an origin with the CLI diff --git a/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/get_started.md b/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/get_started.md index fbe2a484a9..1b322b29e9 100644 --- a/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/get_started.md +++ b/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/get_started.md @@ -1,6 +1,7 @@ +++ title = "Get Started with Chef Habitat" gh_repo = "habitat" +draft = true [menu] [menu.habitat] @@ -134,7 +135,7 @@ Use the Habitat Studio to generate a Habitat package and preview the running Nod ## Manage the Service with Habitat Builder -[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. +[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. 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. diff --git a/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/origins.md b/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/origins.md index 22ccf4b1dc..752f458df9 100644 --- a/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/origins.md +++ b/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/origins.md @@ -1,57 +1,37 @@ +++ -title = "Create an Origin" -description = "Create an Origin on Chef Habitat Builder" +title = "Overview of Chef Habitat Builder origins" gh_repo = "habitat" [menu] [menu.habitat] - title = "Create an Origin" - identifier = "habitat/origins Create an Origin" + title = "Overview" + identifier = "habitat/origins/overview" parent = "habitat/origins" weight = 10 +++ -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. +{{< readfile file="/habitat/reusable/md/builder_origins.md" >}} -You can join existing origins by invitation and you can create your own origins. -For more on invitations, see [origin membership and RBAC]({{< relref "origin_rbac.md#origin-membership" >}}). +## Chef-owned origins -### Create an Origin +Progress Chef maintains the following origins: -![Chef Habitat Builder without origins](/images/habitat/create-origin.png) +- **core**: Hosts packages for common dependencies and compilers maintained by Progress Chef. +- **chef**: Hosts packages for Chef products like Chef Infra Client, Chef InSpec, and Chef Automate. +- **chef-platform**: Hosts packages for Chef 360 Platform skills. +- **habitat**: Hosts packages required for an on-prem Habitat Builder deployment. -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 ) +## Where can I create an origin -![Creating an origin](/images/habitat/create-origin-form.png) +You can create origins in an on-prem Habitat Builder deployment. +[Chef's public Habitat Builder](https://bldr.habitat.sh) doesn't support creating new origins. -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. +## Create an origin -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: +{{< readfile file="/habitat/reusable/md/create_origins_builder.md" >}} -- Anyone can find and use public packages -- Only users with origin membership can find and use private packages +### Create an origin with the Chef Habitat CLI -When you select **Save and Continue**, Chef Habitat Builder: +{{< readfile file="/habitat/reusable/md/create_origins_cli.md" >}} -1. Creates your origin -1. Creates an [origin key pair]({{< relref "origin_keys.md" >}}) -1. Redirects Chef Habitat Builder to the origin page - -![Origin successfully created](/images/habitat/create-origin-done.png) - -#### Create an Origin with the Chef Habitat CLI - -Use the [hab origin]({{< relref "habitat_cli.md#hab-origin" >}}) commands to manage your origins from the command line. - -Create an origin from the command line with the [hab origin create]({{< relref "habitat_cli.md#hab-origin-create" >}}) command - -```bash -hab origin create -``` - -The results of this command differ slightly from creating an origin on the Chef Habitat Builder site. The CLI command: - -1. Creates an origin on the Chef Habitat Builder site -1. Does _not_ generate an origin key pair - -For more information, see the [`hab origin create`]({{< relref "habitat_cli.md#hab-origin-create" >}}) CLI documentation. +To create key pair for your origin, see the [origin keys]({{< relref "/habitat/origin_keys/#generate-origin-keys" >}}) documentation. diff --git a/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/reusable/md/builder_origins.md b/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/reusable/md/builder_origins.md new file mode 100644 index 0000000000..2868a9298d --- /dev/null +++ b/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/reusable/md/builder_origins.md @@ -0,0 +1,5 @@ +An origin is a unique namespace in Chef Habitat Builder where you can store, share, and build packages. +Once created, an origin cannot be renamed, but it can be deleted or transferred. +For example, the _core_ origin contains foundational packages managed and versioned by the core Chef Habitat maintainers. + +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" >}}). diff --git a/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/reusable/md/create_origins_builder.md b/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/reusable/md/create_origins_builder.md new file mode 100644 index 0000000000..9f24253e6f --- /dev/null +++ b/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/reusable/md/create_origins_builder.md @@ -0,0 +1,25 @@ + +To create an origin in Chef Habitat Builder, follow these steps: + +1. In Habitat Builder, select **My Origins** in the left navigation menu. + +1. On the **My Origins** page, select **Create origin** which opens the **Create New Origin** form. + +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. + +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. + + The difference between public and private packages is: + + - Anyone can find and use public packages. + - Only users with origin membership can find and use private packages. + +1. Select **Save and Continue** + + Habitat Builder does the following: + + - Creates your origin. + - Creates an [origin key pair]({{< relref "/habitat/origin_keys" >}}). + - Redirects Chef Habitat Builder to the origin page. + + ![Origin successfully created](/images/habitat/create-origin-done.png) diff --git a/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/reusable/md/create_origins_cli.md b/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/reusable/md/create_origins_cli.md new file mode 100644 index 0000000000..f97b95ce5f --- /dev/null +++ b/_vendor/github.com/habitat-sh/habitat/components/docs-chef-io/content/habitat/reusable/md/create_origins_cli.md @@ -0,0 +1,8 @@ + +To create an origin with the hab CLI, use the [`hab origin create`]({{< relref "habitat_cli.md#hab-origin-create" >}}) command. For example: + +- ```bash + hab origin create + ``` + + Habitat creates an origin on the Chef Habitat Builder site. diff --git a/_vendor/modules.txt b/_vendor/modules.txt index 6135d026e9..4cca157e76 100644 --- a/_vendor/modules.txt +++ b/_vendor/modules.txt @@ -1,6 +1,6 @@ # github.com/chef/automate/components/docs-chef-io v0.0.0-20250515070321-84edd4277ae8 # github.com/chef/desktop-config/docs-chef-io v0.0.0-20240814044820-5af667d41a43 -# github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20241227173243-de19b906a228 +# github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20250523161510-a254ccc738ad # github.com/chef/chef-server/docs-chef-io v0.0.0-20250414141619-a0fb7ff68e94 # github.com/inspec/inspec/docs-chef-io v0.0.0-20250123110211-42364d842e34 # github.com/inspec/inspec-alicloud/docs-chef-io v0.0.0-20240122032124-a1d2a214e170 diff --git a/go.mod b/go.mod index 56940f9d8e..e69fff74ee 100644 --- a/go.mod +++ b/go.mod @@ -15,7 +15,7 @@ require ( github.com/chef/samples v0.0.0-20250424163637-3393187e624c // indirect github.com/chef/supermarket/docs-chef-io v0.0.0-20241105172430-a362eded8f72 // indirect github.com/cowboy/jquery-hashchange v0.0.0-20100902193700-0310f3847f90 // indirect - github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20241227173243-de19b906a228 // indirect + github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20250523161510-a254ccc738ad // indirect github.com/inspec/inspec-alicloud/docs-chef-io v0.0.0-20240122032124-a1d2a214e170 // indirect github.com/inspec/inspec-aws/docs-chef-io v0.0.0-20240122032232-049dcf822eef // indirect github.com/inspec/inspec-azure/docs-chef-io v0.0.0-20240122032234-c1394fc25525 // indirect diff --git a/go.sum b/go.sum index d8acf16fe6..574ba8f8a5 100644 --- a/go.sum +++ b/go.sum @@ -22,8 +22,8 @@ github.com/chef/supermarket/docs-chef-io v0.0.0-20241105172430-a362eded8f72 h1:m github.com/chef/supermarket/docs-chef-io v0.0.0-20241105172430-a362eded8f72/go.mod h1:D+9mmEZxCwpdhZ8LrEODBWMwMufmJUubSt5NlU/lLB4= github.com/cowboy/jquery-hashchange v0.0.0-20100902193700-0310f3847f90 h1:p/a5iSATj0OjrqJLX/YKxYdGXhZzW58yyyNIC4JY4S0= github.com/cowboy/jquery-hashchange v0.0.0-20100902193700-0310f3847f90/go.mod h1:N/6F0+wmdvL6k0AjqyKIncMRClKAN92atjZdTLtYMaw= -github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20241227173243-de19b906a228 h1:ur/oWo1IJqxeT4DAOHUUh3sIBd/x8cXJYb5nNA8+VMc= -github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20241227173243-de19b906a228/go.mod h1:5GKz/BtTWeTr8vdVQPkvGDQkQ+xiGWLkDsPOXhu2Ps4= +github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20250523161510-a254ccc738ad h1:ouEmy8zUhSus+Tqi0IDVktKo6OCCGQ84xmGNsDQfKdw= +github.com/habitat-sh/habitat/components/docs-chef-io v0.0.0-20250523161510-a254ccc738ad/go.mod h1:5GKz/BtTWeTr8vdVQPkvGDQkQ+xiGWLkDsPOXhu2Ps4= github.com/inspec/inspec-alicloud/docs-chef-io v0.0.0-20240122032124-a1d2a214e170 h1:Q9jEEyv8nZAN5NgJXwMoqjngSz6Bc5ruNc9V72Hk4b4= github.com/inspec/inspec-alicloud/docs-chef-io v0.0.0-20240122032124-a1d2a214e170/go.mod h1:tAazDDBtR5yCl/FNWHnrmkxpfxnOo9B99DyfRE7JH1c= github.com/inspec/inspec-aws/docs-chef-io v0.0.0-20240122032232-049dcf822eef h1:r+GoVO6zbIAtusZ2w6MwUhtDAJicQkYbX0iWwZmuXfQ=