diff --git a/website/content/_index.md b/website/content/_index.md index e21c768..83d1db5 100644 --- a/website/content/_index.md +++ b/website/content/_index.md @@ -1,11 +1,11 @@ --- -title: Boundless Operator +title: Blueprint Operator layout: hextra-home ---
{{< hextra/hero-headline >}} - Boundless Operator + Blueprint Operator {{< /hextra/hero-headline >}}
diff --git a/website/content/docs/bctl-reference/_index.md b/website/content/docs/bctl-reference/_index.md index cafcdb0..9c04f8e 100644 --- a/website/content/docs/bctl-reference/_index.md +++ b/website/content/docs/bctl-reference/_index.md @@ -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. diff --git a/website/content/docs/bctl-reference/apply.md b/website/content/docs/bctl-reference/apply.md index 8a1b47e..54b2d5d 100644 --- a/website/content/docs/bctl-reference/apply.md +++ b/website/content/docs/bctl-reference/apply.md @@ -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 @@ -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` | diff --git a/website/content/docs/bctl-reference/kubeconfig.md b/website/content/docs/bctl-reference/kubeconfig.md index a12277b..3e50246 100644 --- a/website/content/docs/bctl-reference/kubeconfig.md +++ b/website/content/docs/bctl-reference/kubeconfig.md @@ -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` | diff --git a/website/content/docs/bctl-reference/reset.md b/website/content/docs/bctl-reference/reset.md index 592bfd7..7ee4d6b 100644 --- a/website/content/docs/bctl-reference/reset.md +++ b/website/content/docs/bctl-reference/reset.md @@ -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 @@ -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` | diff --git a/website/content/docs/bctl-reference/status.md b/website/content/docs/bctl-reference/status.md index 2c86d9a..3ccc524 100644 --- a/website/content/docs/bctl-reference/status.md +++ b/website/content/docs/bctl-reference/status.md @@ -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` | diff --git a/website/content/docs/bctl-reference/update.md b/website/content/docs/bctl-reference/update.md index 8d952be..506aba5 100644 --- a/website/content/docs/bctl-reference/update.md +++ b/website/content/docs/bctl-reference/update.md @@ -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 @@ -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` | diff --git a/website/content/docs/bctl-reference/upgrade.md b/website/content/docs/bctl-reference/upgrade.md index f6bc1d8..8f9cde6 100644 --- a/website/content/docs/bctl-reference/upgrade.md +++ b/website/content/docs/bctl-reference/upgrade.md @@ -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 @@ -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` | diff --git a/website/content/docs/bctl-reference/verify.md b/website/content/docs/bctl-reference/verify.md index 5942d7b..a0ed94f 100644 --- a/website/content/docs/bctl-reference/verify.md +++ b/website/content/docs/bctl-reference/verify.md @@ -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 | \ No newline at end of file diff --git a/website/content/docs/bctl-reference/version.md b/website/content/docs/bctl-reference/version.md index e893639..ca9ef8d 100644 --- a/website/content/docs/bctl-reference/version.md +++ b/website/content/docs/bctl-reference/version.md @@ -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 diff --git a/website/content/docs/blueprint-reference/_index.md b/website/content/docs/blueprint-reference/_index.md index 36a530f..167be71 100644 --- a/website/content/docs/blueprint-reference/_index.md +++ b/website/content/docs/blueprint-reference/_index.md @@ -4,7 +4,7 @@ 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. @@ -12,7 +12,7 @@ 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 diff --git a/website/content/docs/blueprint-reference/components.md b/website/content/docs/blueprint-reference/components.md index ce83ebf..cff4a0a 100644 --- a/website/content/docs/blueprint-reference/components.md +++ b/website/content/docs/blueprint-reference/components.md @@ -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: @@ -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: diff --git a/website/content/docs/blueprint-reference/kubernetes.md b/website/content/docs/blueprint-reference/kubernetes.md index a5c54fe..ff0fbe0 100644 --- a/website/content/docs/blueprint-reference/kubernetes.md +++ b/website/content/docs/blueprint-reference/kubernetes.md @@ -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: @@ -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 @@ -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 diff --git a/website/content/docs/blueprint-reference/root.md b/website/content/docs/blueprint-reference/root.md index 5931c82..e71d873 100644 --- a/website/content/docs/blueprint-reference/root.md +++ b/website/content/docs/blueprint-reference/root.md @@ -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: ... @@ -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 diff --git a/website/content/docs/blueprint-reference/variables.md b/website/content/docs/blueprint-reference/variables.md index 80f3c7e..da6ecfd 100644 --- a/website/content/docs/blueprint-reference/variables.md +++ b/website/content/docs/blueprint-reference/variables.md @@ -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 diff --git a/website/content/docs/examples/nginx-in-a-single-k0s.md b/website/content/docs/examples/nginx-in-a-single-k0s.md index badde81..19263ba 100644 --- a/website/content/docs/examples/nginx-in-a-single-k0s.md +++ b/website/content/docs/examples/nginx-in-a-single-k0s.md @@ -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 @@ -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: diff --git a/website/content/docs/examples/nginx-in-k0s-with-tf-and-aws.md b/website/content/docs/examples/nginx-in-k0s-with-tf-and-aws.md index e498022..8bd0a68 100644 --- a/website/content/docs/examples/nginx-in-k0s-with-tf-and-aws.md +++ b/website/content/docs/examples/nginx-in-k0s-with-tf-and-aws.md @@ -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 @@ -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" @@ -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: diff --git a/website/content/docs/examples/nginx-in-kind.md b/website/content/docs/examples/nginx-in-kind.md index 1a03f1b..7afd2e0 100644 --- a/website/content/docs/examples/nginx-in-kind.md +++ b/website/content/docs/examples/nginx-in-kind.md @@ -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. @@ -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. diff --git a/website/content/docs/getting-started/_index.md b/website/content/docs/getting-started/_index.md index ad22465..fb3848c 100644 --- a/website/content/docs/getting-started/_index.md +++ b/website/content/docs/getting-started/_index.md @@ -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). diff --git a/website/content/docs/getting-started/getting-started-with-an-existing-cluster.md b/website/content/docs/getting-started/getting-started-with-an-existing-cluster.md index 7f6a879..4cc7e47 100644 --- a/website/content/docs/getting-started/getting-started-with-an-existing-cluster.md +++ b/website/content/docs/getting-started/getting-started-with-an-existing-cluster.md @@ -4,27 +4,27 @@ 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 @@ -32,10 +32,10 @@ boundless-operator-controller-manager 1/1 1 1 33s 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: diff --git a/website/content/docs/getting-started/getting-started-with-k0s-and-libvirt.md b/website/content/docs/getting-started/getting-started-with-k0s-and-libvirt.md index f3a999a..5d98037 100644 --- a/website/content/docs/getting-started/getting-started-with-k0s-and-libvirt.md +++ b/website/content/docs/getting-started/getting-started-with-k0s-and-libvirt.md @@ -4,11 +4,11 @@ draft: false weight: 4 --- -This example shows how to create a single-node k0s cluster in a local VM using Terraform and libvirt. The boundless-operator may then be installed. +This example shows how to create a single-node k0s cluster in a local VM using Terraform and libvirt. The blueprint-operator may then be installed. #### Prerequisites -Along with `boundless` CLI, you will also need the following tools installed: +Along with `blueprint` CLI, you will also need the following tools installed: * [k0sctl](https://github.com/k0sproject/k0sctl#installation) - required for installing a k0s distribution * [terraform](https://www.terraform.io/) - for creating VMs @@ -19,13 +19,13 @@ You will also need an SSH key for authentication with the created VM. #### Create virtual machines -Creating virtual machines can be done using the [example Terraform scripts](https://github.com/mirantiscontainers/boundless/tree/main/terraform/k0s-libvirt). +Creating virtual machines can be done using the [example Terraform scripts](https://github.com/mirantiscontainers/blueprint/tree/main/terraform/k0s-libvirt). After copying the example TF scripts to your local machine, you can create the VMs with the following steps: 1. Create a `terraform.tfvars` file with content similar to: ``` -cluster_name = "boundless-cluster" +cluster_name = "blueprint-cluster" cores = 2 mem_size = "2048" disk_size = 20 @@ -43,7 +43,7 @@ ssh_key_path = "/home/user/.ssh/id_rsa" > virsh machine list > ``` -#### Install Boundless Operator on `k0s` +#### Install Blueprint Operator on `k0s` 1. Verify or edit the blueprint created in the previous step, `cluster.yaml` diff --git a/website/content/docs/getting-started/getting-started-with-k0s-and-terraform.md b/website/content/docs/getting-started/getting-started-with-k0s-and-terraform.md index 469f4e9..bbf883a 100644 --- a/website/content/docs/getting-started/getting-started-with-k0s-and-terraform.md +++ b/website/content/docs/getting-started/getting-started-with-k0s-and-terraform.md @@ -4,11 +4,11 @@ draft: false weight: 4 --- -This example shows how to create a k0s cluster in AWS using Terraform and then install Boundless Operator on it. +This example shows how to create a k0s cluster in AWS using Terraform and then install Blueprint Operator on it. #### Prerequisites -Along with `boundless` CLI, you will also need the following tools installed: +Along with `blueprint` CLI, you will also need the following tools installed: * [k0sctl](https://github.com/k0sproject/k0sctl#installation) - required for installing a k0s distribution * [terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli) - for creating VMs in AWS @@ -17,7 +17,7 @@ You will also need an AWS account and the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCES #### Create virtual machines on AWS -Creating virtual machines on AWS can be easily done using the [example Terraform scripts](https://github.com/mirantiscontainers/boundless/tree/main/terraform/k0s-in-aws). +Creating virtual machines on AWS can be easily done using the [example Terraform scripts](https://github.com/mirantiscontainers/blueprint/tree/main/terraform/k0s-in-aws). After copying the example TF scripts to your local machine, you can create the VMs with the following steps: @@ -40,9 +40,9 @@ region = "us-east-1" > Alternatively, for a visual overview: > Go to the AWS EC2 page. Select the desired region from the dropdown menu at the top-right corner. -#### Install Boundless Operator on `k0s` +#### Install Blueprint Operator on `k0s` -1. Download the example blueprint for [creating a k0s cluster in AWS with TF](https://github.com/mirantiscontainers/boundless/tree/main/blueprints/k0s-in-aws-with-tf/k0s-in-aws-with-tf.yaml) +1. Download the example blueprint for [creating a k0s cluster in AWS with TF](https://github.com/mirantiscontainers/blueprint/tree/main/blueprints/k0s-in-aws-with-tf/k0s-in-aws-with-tf.yaml) 2. Edit the `k0s-in-aws-with-tf.yaml` blueprint to set the `spec.kubernetes.infra.hosts` values to those from the `VMs.yaml` file. @@ -86,8 +86,8 @@ watch -n 1 kubectl get pods --all-namespaces It will take a few moments before the pods are ready: ``` NAMESPACE NAME READY STATUS RESTARTS AGE -boundless-system boundless-operator-controller-manager-677b86bdc4-rtjwb 1/2 Running 0 25s -boundless-system helm-controller-79cc59c76b-vsr2v 1/1 Running 0 5s +blueprint-system blueprint-operator-controller-manager-677b86bdc4-rtjwb 1/2 Running 0 25s +blueprint-system helm-controller-79cc59c76b-vsr2v 1/1 Running 0 5s default helm-install-nginx-mj2qt 0/1 ContainerCreating 0 3s kube-system coredns-878bb57ff-d4j99 1/1 Running 0 40s kube-system konnectivity-agent-jkz62 1/1 Running 0 39s diff --git a/website/content/docs/getting-started/getting-started-with-k0s.md b/website/content/docs/getting-started/getting-started-with-k0s.md index 46ab2a8..def94dc 100644 --- a/website/content/docs/getting-started/getting-started-with-k0s.md +++ b/website/content/docs/getting-started/getting-started-with-k0s.md @@ -8,13 +8,13 @@ This section covers the steps needed to created a basic k0s cluster. #### Prerequisites -Along with `boundless` CLI, you will also need the following tools installed: +Along with `blueprint` CLI, you will also need the following tools installed: * [k0sctl](https://github.com/k0sproject/k0sctl#installation) - required for installing a k0s distribution #### Download the example blueprint -Download the [example blueprint](https://github.com/mirantiscontainers/boundless/tree/main/blueprints/k0s-example/k0s-example.yaml) to your machine. +Download the [example blueprint](https://github.com/mirantiscontainers/blueprint/tree/main/blueprints/k0s-example/k0s-example.yaml) to your machine. This blueprint is setup to install the cluster on your local machine without the need for any additional configuration. diff --git a/website/content/docs/getting-started/getting-started-with-kind.md b/website/content/docs/getting-started/getting-started-with-kind.md index 3b23d04..213301c 100644 --- a/website/content/docs/getting-started/getting-started-with-kind.md +++ b/website/content/docs/getting-started/getting-started-with-kind.md @@ -4,11 +4,11 @@ draft: false weight: 2 --- -This example shows how to create a kind cluster using a blueprint with the Boundless Operator and an example server installed on it. +This example shows how to create a kind cluster using a blueprint with the Blueprint Operator and an example server installed on it. #### Prerequisites -Along with `boundless` CLI, you will also need the following tools: +Along with `blueprint` CLI, you will also need the following tools: * [kind](https://kind.sigs.k8s.io/docs/user/quick-start/) - required for installing a kind distribution diff --git a/website/content/docs/install/_index.md b/website/content/docs/install/_index.md index 32f0971..e168260 100644 --- a/website/content/docs/install/_index.md +++ b/website/content/docs/install/_index.md @@ -8,16 +8,16 @@ weight: 1 #### Latest -Installing the latest version of Boundless is as simple as running the following command: +Installing the latest version of Blueprint is as simple as running the following command: ```shell /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/mirantiscontainers/blueprint/main/scripts/install.sh)" ``` -The install script will download the latest version of the boundless cli, verify it with the checksum, and install it to `/usr/local/bin/bctl`. +The install script will download the latest version of the blueprint cli, verify it with the checksum, and install it to `/usr/local/bin/bctl`. #### Specific version -If you would like to install a specific version of Boundless, you can specify the version as an environment var for the install script: +If you would like to install a specific version of Blueprint, you can specify the version as an environment var for the install script: ```shell /bin/bash -c "VERSION= $(curl -fsSL https://raw.githubusercontent.com/mirantiscontainers/blueprint/main/scripts/install.sh)" @@ -27,11 +27,11 @@ You can find the different releases on the [releases page](https://github.com/mi ### Manual installation -Open the [releases page](https://github.com/mirantiscontainers/blueprint/releases) and download the correct binary for your machine along with the boundless_\_checksums.txt file. +Open the [releases page](https://github.com/mirantiscontainers/blueprint/releases) and download the correct binary for your machine along with the blueprint_\_checksums.txt file. Place both in the same directory and run the following command: ```shell -sha256sum -c boundless__checksums.txt --ignore-missing 2>/dev/null +sha256sum -c blueprint__checksums.txt --ignore-missing 2>/dev/null ``` This will only print `OK` if at least one of the files matches the checksums in the checksum file. Otherwise, it will return an error. @@ -44,17 +44,17 @@ tar xzf bctl__.tar.gz -C /usr/local/bin/ ### Additional tools -These are tools that are not required to run Boundless, but are useful for interacting with the cluster. +These are tools that are not required to run Blueprint, but are useful for interacting with the cluster. * [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) - useful for interacting with the cluster -### Uninstall Boundless +### Uninstall Blueprint -To uninstall Boundless, simply delete the binary from your system. +To uninstall Blueprint, simply delete the binary from your system. ```shell rm /usr/local/bin/bctl ``` ### Getting started -Now that you have boundless installed, check out the [getting started guide](../getting-started) to walk through creating your first cluster or go straight to the [examples](docs/examples) section to see some example blueprints. +Now that you have blueprint installed, check out the [getting started guide](../getting-started) to walk through creating your first cluster or go straight to the [examples](docs/examples) section to see some example blueprints.