Skip to content

Commit

Permalink
Extending docs with sections about custom container platform and OS/A…
Browse files Browse the repository at this point in the history
…RCH for building binaries. Bumping remark-cli to suppress errors and warnings on linting markdown files.
  • Loading branch information
andream16 committed Sep 16, 2024
1 parent b093004 commit bc7a9ac
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 21 deletions.
42 changes: 41 additions & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,8 @@ KiND cluster, that's not the case. Instead, the registry's host is
deploy the pipelines and their image repositories will also have to be set to
this value.*

*\*\*Make sure that you use the draconctl image that you pushed in the repository.*
*\*\*Make sure that you use the draconctl image that you pushed in the
repository.*

#### Using a different base image for your images

Expand All @@ -191,6 +192,45 @@ these components have their own Makefiles. In those cases you can place a
`.custom_image` file in the directory with the base image you wish to use and
that will be picked up by the Makefile and build the container.

#### Building binaries and images for non linux/amd64 architecture

*\*Useful for Apple Silicon chips users.*

###### Containers

If you need your images to be built for non linux/amd64 architecture,
you can supply the flag `CONTAINER_OS_ARCH` for customisation of containers.

This can be passed to the make commands used to build images, for example:

```bash
make CONTAINER_OS_ARCH=linux/arm64 components
```

or:

```bash
make CONTAINER_OS_ARCH=linux/arm64 publish-containers
```

By default, when `CONTAINER_ARCH` is not supplied, `linux/amd64` is used.

###### Binaries

`GOOS` and `GOARCH` can be supplied for customisation of the go binaries.

These can be passed to the make commands used to build binaries, for example:

```bash
make GOOS=linux GOARCH=arm64 component-binaries
```

By default `linux` and `amd64` are used.

\**For Apple Silicon chips, you might want to use
`GOOS=darwin` and `GOARCH=arm64` when building binaries
locally for development.*

#### Deploying your custom Dracon components Helm package

You can package your components into a Helm package by running the following
Expand Down
29 changes: 10 additions & 19 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
]
},
"devDependencies": {
"remark-cli": "^12.0.0",
"remark-cli": "^12.0.1",
"remark-lint-list-item-indent": "^4.0.0",
"remark-lint-no-shell-dollars": "^4.0.0",
"remark-preset-lint-consistent": "^6.0.0",
Expand Down

0 comments on commit bc7a9ac

Please sign in to comment.