From bb5e5d08f5dc070bb823adcd92d4a0a9d6796360 Mon Sep 17 00:00:00 2001 From: m4wh6k <84995001+m4wh6k@users.noreply.github.com> Date: Sun, 24 Oct 2021 17:57:08 -0700 Subject: [PATCH] Update Orbit README to reflect packaging now done with fleetctl (#2626) --- changes/update-orbit-readme-about-packaging | 1 + orbit/README.md | 14 +++++++------- 2 files changed, 8 insertions(+), 7 deletions(-) create mode 100644 changes/update-orbit-readme-about-packaging diff --git a/changes/update-orbit-readme-about-packaging b/changes/update-orbit-readme-about-packaging new file mode 100644 index 0000000000..f5f25f336d --- /dev/null +++ b/changes/update-orbit-readme-about-packaging @@ -0,0 +1 @@ +* Updates Orbit README since fleetctl is now used for building packages. diff --git a/orbit/README.md b/orbit/README.md index 3b3d1da3be..e68db81a8a 100644 --- a/orbit/README.md +++ b/orbit/README.md @@ -8,12 +8,12 @@ Orbit is the recommended agent for Fleet. But Orbit can be used with or without ## Try Orbit -#### With [`fleetctl preview` already running](https://github.com/fleetdm/fleet#try-fleet) and [Go](https://golang.org/doc/install) 1.16 installed: +#### With [`fleetctl preview` already running](https://github.com/fleetdm/fleet#try-fleet): ```bash -# From within the orbit/ directory in this repo… +# With fleetctl in your $PATH # Generate a macOS installer pointed at your local Fleet -go run ./cmd/package --type=pkg --fleet-url=localhost:8412 --insecure --enroll-secret=YOUR_FLEET_ENROLL_SECRET_HERE +fleetctl package --type=pkg --fleet-url=localhost:8412 --insecure --enroll-secret=YOUR_FLEET_ENROLL_SECRET_HERE ``` > With fleetctl preview running, you can find your Fleet enroll secret by selecting the "Add new host" button on the Hosts page in the Fleet UI. @@ -117,7 +117,7 @@ Building Windows packages requires Docker to be installed. ### Building packages -Use `go run ./cmd/package` from this directory to run the packaging tools. +Use `fleetctl package` to run the packaging tools. The only required parameter is `--type`, use one of `deb`, `rpm`, `pkg`, or `msi`. @@ -126,14 +126,14 @@ Configure osquery to connect to a Fleet (or other TLS) server with the `--fleet- A minimal invocation for communicating with Fleet: ```sh -go run ./cmd/package --type deb --fleet-url=fleet.example.com --enroll-secret=notsosecret +fleetctl package --type deb --fleet-url=fleet.example.com --enroll-secret=notsosecret ``` This will build a `.deb` package configured to communicate with a Fleet server at `fleet.example.com` using the enroll secret `notsosecret`. When the Fleet server uses a self-signed (or otherwise invalid) TLS certificate, package with the `--insecure` or `--fleet-certificate` options. -See `go run ./cmd/package` for the full range of packaging options. +See `fleetctl package` for the full range of packaging options. #### Update channels @@ -160,7 +160,7 @@ For Notarization, valid App Store Connect credentials must be available on the b Build a signed and notarized macOS package with an invocation like the following: ```sh -AC_USERNAME=zach@example.com AC_PASSWORD=llpk-sije-kjlz-jdzw go run ./cmd/package --type=pkg --fleet-url=fleet.example.com --enroll-secret=63SBzTT+2UyW --sign-identity 3D7260BF99539C6E80A94835A8921A988F4E6498 --notarize +AC_USERNAME=zach@example.com AC_PASSWORD=llpk-sije-kjlz-jdzw fleetctl package --type=pkg --fleet-url=fleet.example.com --enroll-secret=63SBzTT+2UyW --sign-identity 3D7260BF99539C6E80A94835A8921A988F4E6498 --notarize ``` This process may take several minutes to complete as the Notarization process completes on Apple's servers.