Skip to content

Commit

Permalink
update build documentation and binary name
Browse files Browse the repository at this point in the history
  • Loading branch information
sudomateo committed Dec 19, 2024
1 parent 063fb44 commit 8e3b6df
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 7 deletions.
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
GO = go

BINDIR := bin
BINARY := oxide-rancher-machine-driver

# Rancher expects the the binary name to match the format
# `docker-machine-driver-*` otherwise it will error.
BINARY := docker-machine-driver-oxide

LDFLAGS := -ldflags "-w -s -extldflags '-static -Wl,--fatal-warnings'"
TAGS := "netgo osusergo no_stage static_build"
Expand Down
13 changes: 7 additions & 6 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,25 @@

This repository contains the Oxide Rancher machine driver, also known as a node
driver in Rancher parlance. Rancher uses this node driver to provision virtual
machines on Oxide and install Kubernetes on those virtual machines.
machines on Oxide that can then be used to deploy Kubernetes clusters.

== Build

Build the binary using `+make+`.

[source,sh]
----
make build
make
----

== Deployment

Upload a built binary somewhere accessible from Rancher. The binary name must
match the format `docker-machine-driver-*` otherwise Rancher will error when
trying to create a new node driver.
Upload the built binary somewhere accessible from Rancher. The binary name must
match the format `+docker-machine-driver-*+` (e.g.,
`+docker-machine-driver-oxide+`) otherwise Rancher will error when trying to
activate the node driver.

Ensure your `kubectl` context is configured to use your Rancher Kubernetes
Ensure your `+kubectl+` context is configured to use your Rancher Kubernetes
cluster.

Create the following Kubernetes manifest.
Expand Down

0 comments on commit 8e3b6df

Please sign in to comment.