Skip to content

Commit

Permalink
rename boundless to blueprint in docs (#62)
Browse files Browse the repository at this point in the history
* rename boundless to blueprint in docs

* corrected blueprint-operator url
  • Loading branch information
vivek authored Nov 15, 2024
1 parent b591446 commit 73d3ecb
Show file tree
Hide file tree
Showing 25 changed files with 89 additions and 89 deletions.
4 changes: 2 additions & 2 deletions website/content/_index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Boundless Operator
title: Blueprint Operator
layout: hextra-home
---

<div class="mt-6 mb-6">
{{< hextra/hero-headline >}}
Boundless&nbsp;<br class="sm:block hidden" />Operator
Blueprint&nbsp;<br class="sm:block hidden" />Operator
{{< /hextra/hero-headline >}}
</div>

Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/bctl-reference/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ draft: false
weight: 5
---

`bctl` is a command line tool for creating and managing Boundless clusters. It makes interacting with Boundless clusters easy and intuitive.
`bctl` is a command line tool for creating and managing Blueprint clusters. It makes interacting with Blueprint clusters easy and intuitive.

If you haven't installed `bctl` yet, see the [installation](../install) page.

Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/bctl-reference/apply.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ draft: false
weight: 5
---

`bctl apply` is used to apply a configuration to a cluster. It is used to create the underlying cluster, install the `boundless-operator`, and install the designated boundless addons.
`bctl apply` is used to apply a configuration to a cluster. It is used to create the underlying cluster, install the `blueprint-operator`, and install the designated blueprint addons.

## Usage

Expand All @@ -17,5 +17,5 @@ bctl apply [flags]
| Flag | Description | Default |
| ---- | ----------- | ------- |
| `-h, --help` | Display the help for apply |
| `-f, --file` | The path to the blueprint file to apply | `./boundless.yaml` |
| `operator-uri` | The URL or path of the boundless-operator manifest to use | `https://raw.githubusercontent.com/mirantiscontainers/boundless/main/deploy/static/boundless-operator.yaml` |
| `-f, --file` | The path to the blueprint file to apply | `./blueprint.yaml` |
| `operator-uri` | The URL or path of the blueprint-operator manifest to use | `https://github.com/mirantiscontainers/blueprint/releases/latest/download/blueprint-operator.yaml` |
2 changes: 1 addition & 1 deletion website/content/docs/bctl-reference/kubeconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ bctl kubeconfig [flags]
| Flag | Description | Default |
| ---- |--------------------------------------------------------------------| ------- |
| `-h, --help` | Display the help for kubeconfig |
| `-f, --file` | The path to the current blueprint file used to generate kubeconfig | `./boundless.yaml` |
| `-f, --file` | The path to the current blueprint file used to generate kubeconfig | `./blueprint.yaml` |
4 changes: 2 additions & 2 deletions website/content/docs/bctl-reference/reset.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ draft: false
weight: 5
---

`bctl reset` is used to reset a cluster. It is used to remove the underlying cluster, uninstall the `boundless-operator`, and uninstall the designated boundless addons.
`bctl reset` is used to reset a cluster. It is used to remove the underlying cluster, uninstall the `blueprint-operator`, and uninstall the designated blueprint addons.

## Usage

Expand All @@ -17,4 +17,4 @@ bctl reset [flags]
| Flag | Description | Default |
| ---- | ----------- | ------- |
| `-h, --help` | Display the help for reset |
| `-f, --file` | The path to the blueprint file to reset | `./boundless.yaml` |
| `-f, --file` | The path to the blueprint file to reset | `./blueprint.yaml` |
10 changes: 5 additions & 5 deletions website/content/docs/bctl-reference/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ bctl status [flags]

## Flags

| Flag | Description | Default |
| ---- | ----------- | ------- |
| `-h, --help` | Display the help for status |
| `-f, --file` | The path to the blueprint file to check the status of | `./boundless.yaml` |
| `operator-uri` | The URL or path of the boundless-operator manifest to use | `https://raw.githubusercontent.com/mirantiscontainers/boundless/main/deploy/static/boundless-operator.yaml` |
| Flag | Description | Default |
| ---- |------------------------------------------------------------| ------- |
| `-h, --help` | Display the help for status |
| `-f, --file` | The path to the blueprint file to check the status of | `./blueprint.yaml` |
| `operator-uri` | The URL or path of the blueprint-operator manifest to use | `The URL or path of the blueprint-operator manifest to use | `https://github.com/mirantiscontainers/blueprint/releases/latest/download/blueprint-operator.yaml` |
4 changes: 2 additions & 2 deletions website/content/docs/bctl-reference/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ draft: false
weight: 5
---

`bctl update` is used to update a cluster. It is used to update the underlying cluster, update the `boundless-operator`, and update the designated boundless addons according to the provided blueprint.
`bctl update` is used to update a cluster. It is used to update the underlying cluster, update the `blueprint-operator`, and update the designated blueprint addons according to the provided blueprint.

## Usage

Expand All @@ -17,4 +17,4 @@ bctl update [flags]
| Flag | Description | Default |
| ---- | ----------- | ------- |
| `-h, --help` | Display the help for update |
| `-f, --file` | The path to the blueprint file to use for the update | `./boundless.yaml` |
| `-f, --file` | The path to the blueprint file to use for the update | `./blueprint.yaml` |
6 changes: 3 additions & 3 deletions website/content/docs/bctl-reference/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ draft: false
weight: 5
---

`bctl upgrade` is used to upgrade the boundless operator on a cluster.
`bctl upgrade` is used to upgrade the blueprint operator on a cluster.

## Usage

Expand All @@ -17,5 +17,5 @@ bctl upgrade [flags]
| Flag | Description | Default |
| ---- | ----------- | ------- |
| `-h, --help` | Display the help for update |
| `-f, --file` | The path to the blueprint file to use for the upgrade | `./boundless.yaml` |
| `operator-uri` | The URL or path of the boundless-operator manifest to use | `https://raw.githubusercontent.com/mirantiscontainers/boundless/main/deploy/static/boundless-operator.yaml` |
| `-f, --file` | The path to the blueprint file to use for the upgrade | `./blueprint.yaml` |
| `operator-uri` | The URL or path of the blueprint-operator manifest to use | `https://github.com/mirantiscontainers/blueprint/releases/latest/download/blueprint-operator.yaml` |
2 changes: 1 addition & 1 deletion website/content/docs/bctl-reference/verify.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ bctl verify [flags]
| Flag | Description | Default |
|------------------|------------------------------------------|--------------------|
| `-h, --help` | Display the help for verify |
| `-f, --file` | The path to the blueprint file to verify | `./boundless.yaml` |
| `-f, --file` | The path to the blueprint file to verify | `./blueprint.yaml` |
| `-l, --logLevel` | log level to use | info |
2 changes: 1 addition & 1 deletion website/content/docs/bctl-reference/version.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ draft: false
weight: 5
---

`bctl version` is used to get the version of the boundless CLI.
`bctl version` is used to get the version of the blueprint CLI.

## Usage

Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/blueprint-reference/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ draft: false
weight: 7
---

Boundless uses a YAML blueprint to configure the application. The blueprint is
Blueprint uses a YAML blueprint to configure the application. The blueprint is
a single file that contains all the information needed to setup and work with a cluster.
This section will cover the different fields in a blueprint and how you can customize it to
fit your needs.

An example of the full blueprint structure is shown below:

```yaml
apiVersion: boundless.mirantis.com/v1alpha1
apiVersion: blueprint.mirantis.com/v1alpha1
kind: Blueprint
metadata:
name: k0s-cluster
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/blueprint-reference/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ The following example updates the `failureThreshold` of the metallb controller c
- name: metallb
kind: "Manifest"
enabled: true
namespace: boundless-system
namespace: blueprint-system
manifest:
url: "https://raw.githubusercontent.com/metallb/metallb/v0.13.10/config/manifests/metallb-native.yaml"
values:
Expand Down Expand Up @@ -186,7 +186,7 @@ If the metallb addon is created using this example, the metalLB instance that ge
- name: metallb
kind: "Manifest"
enabled: true
namespace: boundless-system
namespace: blueprint-system
manifest:
url: "https://raw.githubusercontent.com/metallb/metallb/v0.13.10/config/manifests/metallb-native.yaml"
values:
Expand Down
24 changes: 12 additions & 12 deletions website/content/docs/blueprint-reference/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ draft: false
weight: 11
---

The `kubernetes` field is used to specify the kubernetes provider and version. This field is optional and not specifying it will result in boundless defaulting to the `existing` provider.
The `kubernetes` field is used to specify the kubernetes provider and version. This field is optional and not specifying it will result in blueprint defaulting to the `existing` provider.

There are currently two kubernetes providers that are officially supported by boundless: `kind` and `k0s`.
There are currently two kubernetes providers that are officially supported by blueprint: `kind` and `k0s`.

An `existing` provider can also be used to specify an unsupported kubernetes provider. Using this provider will install boundless and the specified addons on an existing kubernetes cluster but no cluster management will be possible. If a kubeconfig is not specified, boundless will fail to find the existing cluster.
An `existing` provider can also be used to specify an unsupported kubernetes provider. Using this provider will install blueprint and the specified addons on an existing kubernetes cluster but no cluster management will be possible. If a kubeconfig is not specified, blueprint will fail to find the existing cluster.

> Using an unsupported kubernetes provider expects that the underlying cluster is being managed outside of boundless.
> Using an unsupported kubernetes provider expects that the underlying cluster is being managed outside of blueprint.
## k0s

Specifying a `k0s` will create a k0s cluster, install the boundless operator, and install the specified components. The following is an example of how to specify a `k0s` cluster:
Specifying a `k0s` will create a k0s cluster, install the blueprint operator, and install the specified components. The following is an example of how to specify a `k0s` cluster:

```yaml
spec:
Expand Down Expand Up @@ -52,13 +52,13 @@ spec:
## kind
Specifying a `kind` provider will create a kind cluster, install the boundless operator, and install the specified components. The following is an example of how to specify a `kind` cluster:
Specifying a `kind` provider will create a kind cluster, install the blueprint operator, and install the specified components. The following is an example of how to specify a `kind` cluster:

```yaml
apiVersion: boundless.mirantis.com/v1alpha1
apiVersion: blueprint.mirantis.com/v1alpha1
kind: Blueprint
metadata:
name: boundless-cluster
name: blueprint-cluster
spec:
kubernetes:
provider: kind
Expand All @@ -72,15 +72,15 @@ spec:

## existing

> Using an unsupported kubernetes provider expects that the underlying cluster is being managed outside of boundless.
> Using an unsupported kubernetes provider expects that the underlying cluster is being managed outside of blueprint.

Specifying an `existing` provider will install boundless and the specified addons on an existing kubernetes cluster. This is the default value that will be used if no `kubernetes` section is provided in the blueprint. The following is an example of how to specify an `existing` cluster:
Specifying an `existing` provider will install blueprint and the specified addons on an existing kubernetes cluster. This is the default value that will be used if no `kubernetes` section is provided in the blueprint. The following is an example of how to specify an `existing` cluster:

```yaml
apiVersion: boundless.mirantis.com/v1alpha1
apiVersion: blueprint.mirantis.com/v1alpha1
kind: Blueprint
metadata:
name: boundless-cluster
name: blueprint-cluster
spec:
kubernetes:
provider: existing
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/blueprint-reference/root.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The root fields are the top level fields in a blueprint. These fields are used t
The following is an example of a blueprint with only the root fields:

```yaml
apiVersion: boundless.mirantis.com/v1alpha1
apiVersion: blueprint.mirantis.com/v1alpha1
kind: Blueprint
metadata:
...
Expand All @@ -22,7 +22,7 @@ spec:
## apiVersion
The `apiVersion` field is used to specify the boundless version. This field is required and must be set to one of the versions found in the [boundless repo](https://github.com/MirantisContainers/boundless).
The `apiVersion` field is used to specify the blueprint version. This field is required and must be set to one of the versions found in the [blueprint repo](https://github.com/MirantisContainers/blueprint).

## kind

Expand Down
2 changes: 1 addition & 1 deletion website/content/docs/blueprint-reference/variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export EXAMPLE_VERSION="15.1.1"
and then using it in your blueprint.yaml file

```yaml
apiVersion: boundless.mirantis.com/v1alpha1
apiVersion: blueprint.mirantis.com/v1alpha1
kind: Blueprint
metadata:
name: variable-example
Expand Down
8 changes: 4 additions & 4 deletions website/content/docs/examples/nginx-in-a-single-k0s.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@ title: "Nginx with k0s on a VM"
draft: false
---

This example shows how use boundless to create a single node k0s cluster using a local VM and install [Nginx](https://artifacthub.io/packages/helm/bitnami/nginx) on it.
This example shows how use blueprint to create a single node k0s cluster using a local VM and install [Nginx](https://artifacthub.io/packages/helm/bitnami/nginx) on it.

Popular VMs include

- [lima VM](https://github.com/lima-vm/lima)
- [multipass VM](https://multipass.run/)

Any type of VM can be used to run boundless. If you choose to use another type of VM, you will need to locate the VM's IP address, username, SSH port, and SSH credentials. This example uses a lima VM.
Any type of VM can be used to run blueprint. If you choose to use another type of VM, you will need to locate the VM's IP address, username, SSH port, and SSH credentials. This example uses a lima VM.

#### Prerequisites

Along with `boundless` CLI, the following tools will also be required:
Along with `blueprint` CLI, the following tools will also be required:

- [k0sctl](https://github.com/k0sproject/k0sctl#installation) - required for installing a k0s distribution
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) - used to forward ports to the cluster
Expand All @@ -25,7 +25,7 @@ Start a Lima VM by running `limactl start`. Refer the [Lima documentation](https

#### Setting up the blueprint

Download a copy of the [example Nginx on k0s blueprint](https://raw.githubusercontent.com/mirantiscontainers/boundless/main/blueprints/k0s-example/k0s-example.yaml).
Download a copy of the [example Nginx on k0s blueprint](https://raw.githubusercontent.com/mirantiscontainers/blueprint/main/blueprints/k0s-example/k0s-example.yaml).

Modify the blueprint so that the `spec.kubernetes.infra.hosts` section matches your VM's IP address, username, SSH port, and SSH credentials. The values can be passed as environment variables or replaced with your own values. For example, if you are using a Lima VM, the section should look like this:

Expand Down
8 changes: 4 additions & 4 deletions website/content/docs/examples/nginx-in-k0s-with-tf-and-aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Bootstrap a k0s cluster in AWs with terraform and install Nginx.

#### Pre-requisite

Along with `boundless` CLI, the following tools will also be required:
Along with `blueprint` CLI, the following tools will also be required:

- [AWS](https://aws.amazon.com/cli/) - used to create VMs for running the cluster
- [terraform](https://www.terraform.io/) - used setup VMs in AWS
Expand All @@ -16,12 +16,12 @@ Along with `boundless` CLI, the following tools will also be required:

#### Setting up VMs in AWS

Refer to the [example Terraform scripts](https://github.com/mirantiscontainers/boundless/tree/main/terraform/k0s-in-aws) for creating VMs in AWS.
Refer to the [example Terraform scripts](https://github.com/mirantiscontainers/blueprint/tree/main/terraform/k0s-in-aws) for creating VMs in AWS.

1. Change to the directory containing the Terraform scripts.
2. Copy the `terraform.tfvars.example` to `terraform.tfvars` and change the content to be similar to:
```
cluster_name = "example-boundless"
cluster_name = "example-blueprint"
controller_count = 1
worker_count = 1
cluster_flavor = "m5.large"
Expand All @@ -32,7 +32,7 @@ Refer to the [example Terraform scripts](https://github.com/mirantiscontainers/b

#### Setting up the blueprint

Download the [example blueprint](https://raw.githubusercontent.com/mirantiscontainers/boundless/main/blueprints/k0s-in-aws-with-tf/k0s-in-aws-with-tf.yaml) for Nginx.
Download the [example blueprint](https://raw.githubusercontent.com/mirantiscontainers/blueprint/main/blueprints/k0s-in-aws-with-tf/k0s-in-aws-with-tf.yaml) for Nginx.

Modify the blueprint so that the `spec.kubernetes.infra.hosts` section matches your AWS VMs' IP address, username, SSH port, and SSH credentials. The values can be passed as environment variables or replaced with your own values. For example, the hosts section should match the output from `terraform output --raw bop_cluster`. For example:

Expand Down
10 changes: 5 additions & 5 deletions website/content/docs/examples/nginx-in-kind.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ This blueprint bootstraps a kind cluster and installs Nginx. This is only a basi

#### Prerequisites

Along with `boundless` CLI, the following tools will also be required:
Along with `blueprint` CLI, the following tools will also be required:

- [kind](https://kind.sigs.k8s.io/docs/user/quick-start/) - required for installing a kind distribution
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) - used to forward ports to the cluster

#### Setting up the blueprint

The [example blueprint](https://raw.githubusercontent.com/mirantiscontainers/boundless/main/blueprints/kind-example/kind-example.yaml) for Nginx will bootstrap a `kind` cluster, install `Boundless Operator`, and install Nginx as an addon in the cluster.
The [example blueprint](https://raw.githubusercontent.com/mirantiscontainers/blueprint/main/blueprints/kind-example/kind-example.yaml) for Nginx will bootstrap a `kind` cluster, install `Blueprint Operator`, and install Nginx as an addon in the cluster.

The blueprint can be modified for your setup. Change the `spec.components.addons.chart.values` section to set your own values.

Expand Down Expand Up @@ -44,11 +44,11 @@ kubectl cluster-info --context kind-kind-cluster

Have a nice day! 👋
INF Waiting for nodes to be ready
INF Installing Boundless Operator
INF Installing Blueprint Operator
INF Waiting for all pods to be ready
INF Applying Boundless Operator resource
INF Applying Blueprint Operator resource
INF Applying Blueprint
INF Finished installing Boundless Operator
INF Finished installing Blueprint Operator
```

It will take a few moments before the Nginx pods are ready. You can check the status.
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/getting-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ draft: false
weight: 2
---

This section contains information on how to bootstrap a minimal cluster with Boundless. Additional setups can be found in the [examples](../examples) section.
This section contains information on how to bootstrap a minimal cluster with Blueprint. Additional setups can be found in the [examples](../examples) section.

Make sure you've installed Boundless before continuing. If you haven't, check out the [installation guide](../install).
Make sure you've installed Blueprint before continuing. If you haven't, check out the [installation guide](../install).
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,38 @@ draft: false
weight: 3
---

This example shows how to start using boundless on an existing cluster.
This example shows how to start using blueprint on an existing cluster.

## Install the boundless operator
## Install the blueprint operator

Install Boundless Operator
Install Blueprint Operator

```shell
kubectl apply -f https://raw.githubusercontent.com/mirantiscontainers/boundless/main/deploy/static/boundless-operator.yaml
kubectl apply -f https://github.com/mirantiscontainers/blueprint/releases/latest/download/blueprint-operator.yaml
```

Wait for boundless operator to be ready
Wait for blueprint operator to be ready

```shell
kubectl get deploy -n boundless-system
kubectl get deploy -n blueprint-system
```

Once running, you should see something like this:

```shell
NAME READY UP-TO-DATE AVAILABLE AGE
boundless-operator-controller-manager 1/1 1 1 33s
blueprint-operator-controller-manager 1/1 1 1 33s
```

## Setting up a blueprint

Create a blueprint file `blueprint.yaml` with the following:

```yaml
apiVersion: boundless.mirantis.com/v1alpha1
apiVersion: blueprint.mirantis.com/v1alpha1
kind: Blueprint
metadata:
name: boundless-cluster
name: blueprint-cluster
spec:
components:
addons:
Expand Down
Loading

0 comments on commit 73d3ecb

Please sign in to comment.