diff --git a/cmd/fleet/config_dump.go b/cmd/fleet/config_dump.go index a99fb04b77..b35d8e51bc 100644 --- a/cmd/fleet/config_dump.go +++ b/cmd/fleet/config_dump.go @@ -16,7 +16,7 @@ func createConfigDumpCmd(configManager config.Manager) *cobra.Command { Long: ` Dump the parsed configuration in yaml format. -Kolide retrieves configuration options from many locations, and it can be +Fleet retrieves configuration options from many locations, and it can be useful to see the result of merging those configs. The following precedence is used when reading configs: diff --git a/docs/1-Using-Fleet/2-fleetctl-CLI.md b/docs/1-Using-Fleet/2-fleetctl-CLI.md index 9991b4bc4e..6f82f85eb3 100644 --- a/docs/1-Using-Fleet/2-fleetctl-CLI.md +++ b/docs/1-Using-Fleet/2-fleetctl-CLI.md @@ -493,7 +493,7 @@ spec: org_logo_url: "https://example.org/logo.png" org_name: Example Org server_settings: - kolide_server_url: https://fleet.example.org:8080 + server_url: https://fleet.example.org:8080 smtp_settings: authentication_method: authmethod_plain authentication_type: authtype_username_password diff --git a/docs/1-Using-Fleet/3-REST-API.md b/docs/1-Using-Fleet/3-REST-API.md index f5ed734729..0059ad2d94 100644 --- a/docs/1-Using-Fleet/3-REST-API.md +++ b/docs/1-Using-Fleet/3-REST-API.md @@ -4043,7 +4043,7 @@ None. "org_logo_url": "" }, "server_settings": { - "kolide_server_url": "https://localhost:8080", + "server_url": "https://localhost:8080", "live_query_disabled": false }, "smtp_settings": { @@ -4092,7 +4092,7 @@ Modifies the Fleet's configuration with the supplied information. | --------------------- | ------- | ---- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | org_name | string | body | _Organization information_. The organization name. | | org_logo_url | string | body | _Organization information_. The URL for the organization logo. | -| kolide_server_url | string | body | _Server settings_. The Fleet server URL. | +| server_url | string | body | _Server settings_. The Fleet server URL. | | live_query_disabled | boolean | body | _Server settings_. Whether the live query capabilities are disabled. | | enable_smtp | boolean | body | _SMTP settings_. Whether SMTP is enabled for the Fleet app. | | sender_address | string | body | _SMTP settings_. The sender email address for the Fleet app. An invitation email is an example of the emails that may use this sender address | @@ -4147,7 +4147,7 @@ Modifies the Fleet's configuration with the supplied information. "org_logo_url": "https://fleetdm.com/logo.png" }, "server_settings": { - "kolide_server_url": "https://localhost:8080", + "server_url": "https://localhost:8080", "live_query_disabled": false }, "smtp_settings": { diff --git a/docs/3-Deployment/2-Configuration.md b/docs/3-Deployment/2-Configuration.md index 570899ce95..1ed9ebb51a 100644 --- a/docs/3-Deployment/2-Configuration.md +++ b/docs/3-Deployment/2-Configuration.md @@ -144,39 +144,39 @@ The address of the MySQL server which Fleet should connect to. Include the hostn The name of the MySQL database which Fleet will use. -- Default value: `kolide` +- Default value: `fleet` - Environment variable: `FLEET_MYSQL_DATABASE` - Config file format: ``` mysql: - database: kolide + database: fleet ``` ###### `mysql_username` The username to use when connecting to the MySQL instance. -- Default value: `kolide` +- Default value: `fleet` - Environment variable: `FLEET_MYSQL_USERNAME` - Config file format: ``` mysql: - username: kolide + username: fleet ``` ###### `mysql_password` The password to use when connecting to the MySQL instance. -- Default value: `kolide` +- Default value: `fleet` - Environment variable: `FLEET_MYSQL_PASSWORD` - Config file format: ``` mysql: - password: kolide + password: fleet ``` ##### `mysql_password_path` @@ -371,26 +371,26 @@ The TLS cert to use when terminating TLS. See [TLS certificate considerations](./1-Installation.md#tls-certificate-considerations) for more information about certificates and Fleet. -- Default value: `./tools/osquery/kolide.crt` +- Default value: `./tools/osquery/fleet.crt` - Environment variable: `FLEET_SERVER_CERT` - Config file format: ``` server: - cert: /tmp/kolide.crt + cert: /tmp/fleet.crt ``` ###### `server_key` The TLS key to use when terminating TLS. -- Default value: `./tools/osquery/kolide.key` +- Default value: `./tools/osquery/fleet.key` - Environment variable: `FLEET_SERVER_KEY` - Config file format: ``` server: - key: /tmp/kolide.key + key: /tmp/fleet.key ``` ###### `server_tls` @@ -1250,11 +1250,11 @@ AWS STS role ARN to use for S3 authentication. ## Managing osquery configurations -We recommend that you use an infrastructure configuration management tool to manage these osquery configurations consistently across your environment. If you're unsure about what configuration management tools your organization uses, contact your company's system administrators. If you are evaluating new solutions for this problem, the founders of Kolide have successfully managed configurations in large production environments using [Chef](https://www.chef.io/chef/) and [Puppet](https://puppet.com/). +We recommend that you use an infrastructure configuration management tool to manage these osquery configurations consistently across your environment. If you're unsure about what configuration management tools your organization uses, contact your company's system administrators. If you are evaluating new solutions for this problem, the founders of Fleet have successfully managed configurations in large production environments using [Chef](https://www.chef.io/chef/) and [Puppet](https://puppet.com/). ## Running with systemd -Once you've verified that you can run fleet in your shell, you'll likely want to keep fleet running in the background and after the server reboots. To do that we recommend using [systemd](https://coreos.com/os/docs/latest/getting-started-with-systemd.html). +Once you've verified that you can run Fleet in your shell, you'll likely want to keep Fleet running in the background and after the server reboots. To do that we recommend using [systemd](https://coreos.com/os/docs/latest/getting-started-with-systemd.html). Below is a sample unit file. @@ -1267,7 +1267,7 @@ After=network.target LimitNOFILE=8192 ExecStart=/usr/local/bin/fleet serve \ --mysql_address=127.0.0.1:3306 \ - --mysql_database=kolide \ + --mysql_database=fleet \ --mysql_username=root \ --mysql_password=toor \ --redis_address=127.0.0.1:6379 \ diff --git a/docs/3-Deployment/4-Example-deployment-scenarios.md b/docs/3-Deployment/4-Example-deployment-scenarios.md index 71a3f62325..cf4998f373 100644 --- a/docs/3-Deployment/4-Example-deployment-scenarios.md +++ b/docs/3-Deployment/4-Example-deployment-scenarios.md @@ -1,4 +1,5 @@ # Example deployment scenarios + - [Fleet on CentOS](#fleet-on-centos) - [Setting up a host](#setting-up-a-host) - [Installing Fleet](#installing-fleet) @@ -75,13 +76,15 @@ sudo systemctl start mysqld ``` Let's set a password for the MySQL root user. -MySQL creates an initial temporary root password which you can find in ```/var/log/mysqld.log``` you will need this password to change the root password. +MySQL creates an initial temporary root password which you can find in `/var/log/mysqld.log` you will need this password to change the root password. Connect to MySQL + ``` mysql -u root -p ``` -When prompted enter in the temporary password from ```/var/log/mysqld.log``` + +When prompted enter in the temporary password from `/var/log/mysqld.log` Change root password, in this case we will use `toor?Fl33t` as default password validation requires a more complex password. @@ -96,23 +99,30 @@ For MySQL 5.7.5 and older, use: ``` mysql> SET PASSWORD FOR "root"@"localhost" = PASSWORD("toor?Fl33t"); ``` + Now issue the command + ``` mysql> flush privileges; ``` + And exit MySQL + ``` mysql> exit ``` + Stop MySQL and start again + ``` sudo mysqld stop sudo systemctl start mysqld ``` -It's also worth creating a MySQL database for us to use at this point. Run the following to create the `kolide` database in MySQL. Note that you will be prompted for the password you created above. + +It's also worth creating a MySQL database for us to use at this point. Run the following to create the `fleet` database in MySQL. Note that you will be prompted for the password you created above. ``` -echo 'CREATE DATABASE kolide;' | mysql -u root -p +echo 'CREATE DATABASE fleet;' | mysql -u root -p ``` #### Redis @@ -137,7 +147,7 @@ Now that we have installed Fleet, MySQL, and Redis, we are ready to launch Fleet ``` /usr/bin/fleet prepare db \ --mysql_address=127.0.0.1:3306 \ - --mysql_database=kolide \ + --mysql_database=fleet \ --mysql_username=root \ --mysql_password=toor?Fl33t ``` @@ -167,7 +177,7 @@ Now we are ready to run the server! We do this via `fleet serve`: ``` /usr/bin/fleet serve \ --mysql_address=127.0.0.1:3306 \ - --mysql_database=kolide \ + --mysql_database=fleet \ --mysql_username=root \ --mysql_password=toor \ --redis_address=127.0.0.1:6379 \ @@ -175,7 +185,8 @@ Now we are ready to run the server! We do this via `fleet serve`: --server_key=/tmp/server.key \ --logging_json ``` -You will be prompted to add a value for ```--auth_jwt_key```. A randomly generated key will be suggested, you can simply add the flag with the suggested key. + +You will be prompted to add a value for `--auth_jwt_key`. A randomly generated key will be suggested, you can simply add the flag with the suggested key. Now, if you go to [https://localhost:8080](https://localhost:8080) in your local browser, you should be redirected to [https://localhost:8080/setup](https://localhost:8080/setup) where you can create your first Fleet user account. @@ -183,7 +194,6 @@ Now, if you go to [https://localhost:8080](https://localhost:8080) in your local See [Running with systemd](./2-Configuration.md#running-with-systemd) for documentation on running fleet as a background process and managing the fleet server logs. - ### Installing and running osquery > Note that this whole process is outlined in more detail in the [Adding Hosts To Fleet](./3-Adding-hosts.md) document. The steps are repeated here for the sake of a continuous tutorial. @@ -199,7 +209,7 @@ You will need to set the osquery enroll secret and osquery server certificate. I  -If you select "Fetch Kolide Certificate", your browser will download the appropriate file to your downloads directory (to a file probably called `localhost-8080.pem`). Copy this file to your CentOS host at `/var/osquery/server.pem`. +If you select "Fetch Fleet Certificate", your browser will download the appropriate file to your downloads directory (to a file probably called `localhost-8080.pem`). Copy this file to your CentOS host at `/var/osquery/server.pem`. You can also select "Reveal Secret" on that modal and the enrollment secret for your Fleet instance will be revealed. Copy that text and create a file with its contents: @@ -279,10 +289,10 @@ ps aux | grep mysqld mysql 13158 3.1 14.4 1105320 146408 ? Ssl 21:36 0:00 /usr/sbin/mysqld ``` -It's also worth creating a MySQL database for us to use at this point. Run the following to create the `kolide` database in MySQL. Note that you will be prompted for the password you created above. +It's also worth creating a MySQL database for us to use at this point. Run the following to create the `fleet` database in MySQL. Note that you will be prompted for the password you created above. ``` -echo 'CREATE DATABASE kolide;' | mysql -u root -p +echo 'CREATE DATABASE fleet;' | mysql -u root -p ``` #### Redis @@ -308,7 +318,7 @@ Now that we have installed Fleet, MySQL, and Redis, we are ready to launch Fleet ``` /usr/bin/fleet prepare db \ --mysql_address=127.0.0.1:3306 \ - --mysql_database=kolide \ + --mysql_database=fleet \ --mysql_username=root \ --mysql_password=toor ``` @@ -336,7 +346,7 @@ Now we are ready to run the server! We do this via `fleet serve`: ``` /usr/bin/fleet serve \ --mysql_address=127.0.0.1:3306 \ - --mysql_database=kolide \ + --mysql_database=fleet \ --mysql_username=root \ --mysql_password=toor \ --redis_address=127.0.0.1:6379 \ @@ -344,6 +354,7 @@ Now we are ready to run the server! We do this via `fleet serve`: --server_key=/tmp/server.key \ --logging_json ``` + You will be prompted to add a value for `--auth_jwt_key`. A randomly generated key will be suggested, you can simply add the flag with the suggested key. Now, if you go to [https://localhost:8080](https://localhost:8080) in your local browser, you should be redirected to [https://localhost:8080/setup](https://localhost:8080/setup) where you can create your first Fleet user account. @@ -352,7 +363,6 @@ Now, if you go to [https://localhost:8080](https://localhost:8080) in your local See [Running with systemd](./2-Configuration.md#running-with-systemd) for documentation on running fleet as a background process and managing the fleet server logs. - ### Installing and running osquery > Note that this whole process is outlined in more detail in the [Adding Hosts To Fleet](./3-Adding-hosts.md) document. The steps are repeated here for the sake of a continuous tutorial. @@ -406,7 +416,6 @@ sudo /usr/bin/osqueryd \ If you go back to [https://localhost:8080/hosts/manage](https://localhost:8080/hosts/manage), you should have a host successfully enrolled in Fleet! - ## Deploying Fleet on Kubernetes In this guide, we're going to install Fleet and all of its application dependencies on a Kubernetes cluster. Kubernetes is a container orchestration tool that was open sourced by Google in 2014. @@ -425,13 +434,13 @@ The MySQL that we will use for this tutorial is not replicated and it is not Hig To install MySQL from Helm, run the following command. Note that there are some options that are specified. These options basically just enumerate that: -- There should be a `kolide` database created -- The default user's username should be `kolide` +- There should be a `fleet` database created +- The default user's username should be `fleet` ``` helm install \ --name fleet-database \ - --set mysqlUser=kolide,mysqlDatabase=kolide \ + --set mysqlUser=fleet,mysqlDatabase=fleet \ stable/mysql ``` diff --git a/docs/4-Contribution/FAQ.md b/docs/4-Contribution/FAQ.md index 26538cc68e..5c433e0566 100644 --- a/docs/4-Contribution/FAQ.md +++ b/docs/4-Contribution/FAQ.md @@ -1,4 +1,5 @@ # Contribution FAQ + - [Make errors](#make-errors) - [`dep: command not found`](#dep-command-not-found) - [`undefined: Asset`](#undefined-asset) @@ -20,7 +21,7 @@ See the Go language documentation for [workspaces](https://golang.org/doc/code.h ### `undefined: Asset` ``` -server/kolide/emails.go:90:23: undefined: Asset +server/fleet/emails.go:90:23: undefined: Asset make: *** [fleet] Error 2 ``` @@ -34,7 +35,7 @@ Visit [locahost:8025](http://localhost:8025) to view Mailhog's admin interface w ## Adding hosts for testing -The `osquery` directory contains a docker-compose.yml and additional configuration files to start containerized osquery agents. +The `osquery` directory contains a docker-compose.yml and additional configuration files to start containerized osquery agents. To start osquery, first retrieve the "Enroll Secret" from Fleet (by clicking the "Add New Host") button in the Fleet dashboard, or with `fleetctl get enroll-secret`). diff --git a/frontend/components/forms/RegistrationForm/ConfirmationPage/ConfirmationPage.jsx b/frontend/components/forms/RegistrationForm/ConfirmationPage/ConfirmationPage.jsx index 30e1387b8b..292cf76d5e 100644 --- a/frontend/components/forms/RegistrationForm/ConfirmationPage/ConfirmationPage.jsx +++ b/frontend/components/forms/RegistrationForm/ConfirmationPage/ConfirmationPage.jsx @@ -59,7 +59,7 @@ class ConfirmationPage extends Component { handleSubmit, formData: { email, - kolide_server_url: kolideWebAddress, + server_url: kolideWebAddress, org_name: orgName, username, }, diff --git a/frontend/components/forms/RegistrationForm/ConfirmationPage/ConfirmationPage.tests.jsx b/frontend/components/forms/RegistrationForm/ConfirmationPage/ConfirmationPage.tests.jsx index 7ea12bba60..0f8a6c71d8 100644 --- a/frontend/components/forms/RegistrationForm/ConfirmationPage/ConfirmationPage.tests.jsx +++ b/frontend/components/forms/RegistrationForm/ConfirmationPage/ConfirmationPage.tests.jsx @@ -9,7 +9,7 @@ describe("ConfirmationPage - form", () => { username: "jmeller", email: "jason@kolide.co", org_name: "Kolide", - kolide_server_url: "http://kolide.kolide.co", + server_url: "http://kolide.kolide.co", }; it("renders the user information", () => { @@ -20,7 +20,7 @@ describe("ConfirmationPage - form", () => { expect(form.text()).toContain(formData.username); expect(form.text()).toContain(formData.email); expect(form.text()).toContain(formData.org_name); - expect(form.text()).toContain(formData.kolide_server_url); + expect(form.text()).toContain(formData.server_url); }); it("submits the form", () => { diff --git a/frontend/components/forms/RegistrationForm/KolideDetails/KolideDetails.jsx b/frontend/components/forms/RegistrationForm/KolideDetails/KolideDetails.jsx index c17ac0d576..c12ce59c3f 100644 --- a/frontend/components/forms/RegistrationForm/KolideDetails/KolideDetails.jsx +++ b/frontend/components/forms/RegistrationForm/KolideDetails/KolideDetails.jsx @@ -7,7 +7,7 @@ import Button from "components/buttons/Button"; import helpers from "components/forms/RegistrationForm/KolideDetails/helpers"; import InputFieldWithIcon from "components/forms/fields/InputFieldWithIcon"; -const formFields = ["kolide_server_url"]; +const formFields = ["server_url"]; const { validate } = helpers; class KolideDetails extends Component { @@ -15,7 +15,7 @@ class KolideDetails extends Component { className: PropTypes.string, currentPage: PropTypes.bool, fields: PropTypes.shape({ - kolide_server_url: formFieldInterface.isRequired, + server_url: formFieldInterface.isRequired, }).isRequired, handleSubmit: PropTypes.func.isRequired, }; @@ -42,7 +42,7 @@ class KolideDetails extends Component {