Skip to content

Commit

Permalink
docs: fix documentation links (#83)
Browse files Browse the repository at this point in the history
Signed-off-by: Rich Lander <[email protected]>
  • Loading branch information
lander2k2 authored Aug 14, 2024
1 parent 341f856 commit 7236c93
Show file tree
Hide file tree
Showing 5 changed files with 29 additions and 21 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
## Documentation

User documentation can be found at
[operator-builder.io](https://operator-builder.io).
[operatorbuilder.io](https://operatorbuilder.io).

Developer documentation can be found [here](https://github.com/nukleros/operator-builder/tree/main/docs/dev).

Expand Down Expand Up @@ -80,8 +80,8 @@ building an app stack management operator with Operator Builder:
test them in a Kubernetes cluster. You can also use Helm and the `helm template`
command to create these resources if a helm chart exists.
* Determine which fields in the manifests need to be mutable and managed by the
operator, then add [markers](https://operator-builder.io/markers) to the manifests.
* Create a [workload configuration](https://operator-builder.io/workloads) to give it some details,
operator, then add [markers](https://operatorbuilder.io/markers) to the manifests.
* Create a [workload configuration](https://operatorbuilder.io/workloads) to give it some details,
such as what you would like to call your custom resource.
* Run the Operator Builder CLI in a new repository and provide to it the marked
up manifests and workload config.
Expand All @@ -92,16 +92,16 @@ updating or deleting a custom resource instance.

An operator built with Operator Builder has the following features:

* A defined API for a custom resource based on [markers](https://operator-builder.io/markers) in
* A defined API for a custom resource based on [markers](https://operatorbuilder.io/markers) in
static Kubernetes manifests.
* A functioning controller that will create, update and delete child resources
to reconcile the state for the custom resource/s.
* A [companion CLI](https://operator-builder.io/companion-cli) that helps end users with common
* A [companion CLI](https://operatorbuilder.io/companion-cli) that helps end users with common
operations.

The custom resource defined in the source code can be cluster-scoped or
namespace-scoped based on the requirements of the project. More info
[here](https://operator-builder.io/resource-scope).
[here](https://operatorbuilder.io/resource-scope).

## Advanced Functionality

Expand Down
29 changes: 16 additions & 13 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- Docker (for building/pushing controller images)
- An available test cluster. A local kind or minikube cluster will work just
fine in many cases.
- Operator Builder [installed](#installation).
- Operator Builder [installed](installation.md).
- [kubectl installed](https://kubernetes.io/docs/tasks/tools/#kubectl).
- A set of static Kubernetes manifests that can be used to deploy
your workload. It is highly recommended that you apply these manifests to a
Expand All @@ -24,15 +24,17 @@ the [prerequisites](#prerequisites) prior to attempting to follow this guide.

This guide consists of the following steps:

1. [Create a repository](#step-1).
1. [Create a repository](#step-1-create-a-repo).
1. Determine what fields in your static manifests will need to be configurable for
deployment into different environments. [Add commented markers to the
manifests](#step-2). These will serve as instructions to Operator Builder.
1. [Create a workload configuration for your project](#step-3).
1. [Use the Operator Builder CLI to generate the source code for your operator](#step-4).
1. [Test the operator against your test cluster](#step-5).
1. [Build and install your operator's controller manager in your test cluster](#step-6).
1. [Build and test the operator's companion CLI](#step-7).
manifests](#step-2-add-manifest-markers). These will serve as instructions to Operator Builder.
1. [Create a workload configuration for your
project](#step-3-create-a-workload-config).
1. [Use the Operator Builder CLI to generate the source code for your operator](#step-4-generate-operator-source-code).
1. [Test the operator against your test cluster](#step-5-run-test-the-operator).
1. [Build and install your operator's controller manager in your test cluster](#step-6-build-deploy-the-controller-manager).
1. [Build and test the operator's companion
CLI](#step-7-build-test-companion-cli).

### Step 1: Create a Repo

Expand Down Expand Up @@ -164,15 +166,15 @@ spec:

These markers should always be provided as an in-line comment or as a head
comment. The marker always begins with `+operator-builder:field:` or
`+operator-builder:collection:field:` See [Markers](docs/markers.md) to learn
`+operator-builder:collection:field:` See [Markers](markers.md) to learn
more.

### Step 3: Create a Workload Config

Operator Builder uses a workload configuration to provide important details for
your operator project. This guide uses a [standalone
workload](docs/standalone-workloads.md). Save a workload config to your
`.source-manifests` directory by using one of the following commands (or
workload](standalone-workloads.md). Save a workload config to your
`.source-manifests` directory by using one of the following commands (or
simply copy/pasting the YAML below the commands):

```bash
Expand Down Expand Up @@ -443,6 +445,7 @@ resources as follows.
make undeploy
```

For more information, checkout the [Operator Builder docs](docs/) as
well as the [Kubebuilder docs](https://kubebuilder.io/).
## Next Step

Learn about [Workloads](workloads.md).

2 changes: 1 addition & 1 deletion docs/markers.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ The `metadata.name` field from the collection workload is also supported:
The other required field is the `type` field which specifies the data type for
the value.

[#supported-field-types]() The supported data types are:
The supported data types are:

- bool
- string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ in the accompanying `.operator-builder` directory.

* [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
* [golang](https://go.dev/doc/install)
* [operator-builder](https://github.com/nukleros/operator-builder/blob/main/docs/installation.md)
* [operator-builder](../installation.md)

## Setup

Expand Down
5 changes: 5 additions & 0 deletions docs/workload-collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,3 +135,8 @@ spec:
app: frontend
```

## Next Step

Follow the [workload collection
tutorial](workload-collection-tutorial/workload-collection-tutorial.md).

0 comments on commit 7236c93

Please sign in to comment.