Docs image updates (#2297)
* addred cropped images to replace images in configuration.md, fixed duplicated alt text, added box-shadow to images * more cropping * reduce padding on ordered lists, point urls in markdown to where images will be * Update 02-Configuration.md * Update build-static-content.js * remove box-shadow on images * Update 02-Configuration.md * Added handbook entry about images * changed img tags to markdown links to be consistent * undo small style change * Update build-static-content.js * Update handbook/product.md Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com> Co-authored-by: Mike Thomas <78363703+mike-j-thomas@users.noreply.github.com>
This commit is contained in:
eashaw
@@ -14,7 +14,7 @@ Once you log into Fleet, you are presented with the **Hosts** page.
|
||||
|
||||
>In Fleet, devices are referred to as "hosts."
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/78363703/130040107-02d0161f-0afe-49db-a9b1-116149ed9814.png" alt="Fleet query search"/>
|
||||
|
||||
|
||||
On this page you'll see 7 hosts by default. These hosts are simulated Linux devices, and like the Fleet preview environment, they're running locally on your computer in Docker.
|
||||
|
||||
@@ -33,7 +33,7 @@ These questions can easily be answered, by running this simple query: "Get OpenS
|
||||
On the **Queries** page, enter the query name, "Get OpenSSL versions," in the search box, and select it to enter the **query console**. Then from the **query console**, hit "Run query", and from the "Select targets" page, select "All hosts," to run this query against all hosts enrolled in your Fleet. Then hit the "Run" button to execute the query.
|
||||
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/78363703/134630888-da9e7244-7d5d-4724-87ef-1bb41737308f.png" alt="Fleet select targets"/>
|
||||
|
||||
|
||||
|
||||
The query may take several seconds to complete, because Fleet has to wait for the osquery agents to respond with results.
|
||||
@@ -43,7 +43,7 @@ The query may take several seconds to complete, because Fleet has to wait for th
|
||||
When the query has finished, you should see 4 columns and several rows in the "Results" table:
|
||||
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/78363703/134631391-cb62fbd4-81ab-4ea6-8e38-807cccc9c6cc.png" alt="Fleet query results"/>
|
||||
|
||||
|
||||
|
||||
- The "hostname" column answers: which device responded for a given row of results?
|
||||
@@ -88,26 +88,27 @@ To add your own device to Fleet, you'll first need to install the osquery agent.
|
||||
|
||||
1. Make a clone of [Orbit's GitHub repository](https://github.com/fleetdm/orbit).
|
||||
|
||||
> Take note on where your new Orbit directory is located on you device. Knowing this will be helpful when building the Orbit package in step 3.
|
||||
> Take note on where your new Orbit directory is located on you device. Knowing this will be helpful when building the Orbit package in step 3.
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/78363703/133367260-d78d1e11-b8a9-4c36-a39b-b11b2f4d1197.png" alt="Clone Orbit repository"/>
|
||||
|
||||
|
||||
2. In Fleet UI's Host page, hit the "Add new host" button, and copy your Fleet enroll secret (you'll need this in the next step.)
|
||||
|
||||
<img src="https://user-images.githubusercontent.com/78363703/130040559-9eb77221-aeba-45ce-8f8a-fb1913d3843b.png" alt="Clone Orbit repository"/>
|
||||
|
||||
|
||||
3. With [fleetctl preview](http://fleetdm.com/get-started) still running, and [Go](https://golang.org/doc/install) 1.16 installed, run the following command (remembering to swap ```YOUR_FLEET_ENROLL_SECRET_HERE``` for the one you copied in the previous step:
|
||||
|
||||
```
|
||||
# From within the top-level directory of your cloned Orbit repository…
|
||||
# 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```
|
||||
```
|
||||
> If you'd like to build a Windows package, set `--type=msi` in the above command. If you'd like to build a Linux package, set `--type=deb` (Debian, Ubuntu, etc.) or `--type=rpm` (RHEL, CentOS, etc.) in the above command.
|
||||
```
|
||||
# From within the top-level directory of your cloned Orbit repository…
|
||||
# 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
|
||||
```
|
||||
|
||||
A package configured to point at your Fleet instance has now been generated in your local Orbit repository
|
||||
> If you'd like to build a Windows package, set `--type=msi` in the above command. If you'd like to build a Linux package, set `--type=deb` (Debian, Ubuntu, etc.) or `--type=rpm` (RHEL, CentOS, etc.) in the above command.
|
||||
|
||||
A package configured to point at your Fleet instance has now been generated in your local Orbit repository
|
||||
|
||||
4. Navigate to your generated package (use ```open .``` from macOS commandline,) then double click on the package, and finally complete the installation walkthrough to enroll your device as a host in Fleet.
|
||||
|
||||
> It may take several seconds (≈30s) for your device to enroll. Refresh Fleet UI, and you should now see your local device in your list of hosts.
|
||||
> It may take several seconds (≈30s) for your device to enroll. Refresh Fleet UI, and you should now see your local device in your list of hosts.
|
||||
|
||||
|
||||
@@ -1428,6 +1428,7 @@ To download the data streams, you can use `fleetctl vulnerability-data-stream --
|
||||
```
|
||||
vulnerabilities:
|
||||
disable_data_sync: true
|
||||
```
|
||||
|
||||
## Managing osquery configurations
|
||||
|
||||
@@ -1440,6 +1441,7 @@ Once you've verified that you can run Fleet in your shell, you'll likely want to
|
||||
Below is a sample unit file.
|
||||
|
||||
```
|
||||
|
||||
[Unit]
|
||||
Description=Fleet
|
||||
After=network.target
|
||||
@@ -1557,52 +1559,52 @@ Follow these steps to configure Fleet SSO with Google Workspace. This will requi
|
||||
|
||||
1. Navigate to the [Web and Mobile Apps](https://admin.google.com/ac/apps/unified) section of the Google Workspace dashboard. Click _Add App -> Add custom SAML app_.
|
||||
|
||||
<img width="1904" alt="Screen Shot 2021-09-15 at 2 47 36 PM" src="https://user-images.githubusercontent.com/575602/133529965-cb067c4a-3d11-460e-aa72-958a6462a6ae.png">
|
||||
|
||||
|
||||
2. Enter `Fleet` for the _App name_ and click _Continue_.
|
||||
|
||||
<img width="1904" alt="Screen Shot 2021-09-15 at 2 50 06 PM" src="https://user-images.githubusercontent.com/575602/133530058-95183355-6e6b-4dfd-b622-1b012809a1bd.png">
|
||||
|
||||
|
||||
3. Click _Download Metadata_, saving the metadata to your computer. Copy the _SSO URL_. Click _Continue_.
|
||||
|
||||
<img width="1904" alt="Screen Shot 2021-09-15 at 2 52 56 PM" src="https://user-images.githubusercontent.com/575602/133530200-af839b88-0eba-4403-b095-2fed4632b6be.png">
|
||||
|
||||
|
||||
4. In Fleet, navigate to the _Organization Settings_ page. Configure the _SAML Single Sign On Options_ section.
|
||||
|
||||
- Check the _Enable Single Sign On_ checkbox.
|
||||
- For _Identity Provider Name_ use `Google`.
|
||||
- For _Entity ID_, use a unique identifier such as `fleet.example.com`. Note that Google seems to error when the provided ID includes `https://`.
|
||||
- For _Issuer URI_, paste the _SSO URL_ copied from step 3.
|
||||
- For _Metadata_, paste the contents of the downloaded metadata XML from step 3.
|
||||
- All other fields can be left blank.
|
||||
- Check the _Enable Single Sign On_ checkbox.
|
||||
- For _Identity Provider Name_ use `Google`.
|
||||
- For _Entity ID_, use a unique identifier such as `fleet.example.com`. Note that Google seems to error when the provided ID includes `https://`.
|
||||
- For _Issuer URI_, paste the _SSO URL_ copied from step 3.
|
||||
- For _Metadata_, paste the contents of the downloaded metadata XML from step 3.
|
||||
- All other fields can be left blank.
|
||||
|
||||
Click _Update settings_ at the bottom of the page.
|
||||
Click _Update settings_ at the bottom of the page.
|
||||
|
||||
<img width="1904" alt="Screen Shot 2021-09-15 at 5 32 25 PM" src="https://user-images.githubusercontent.com/575602/133530548-4651bf76-e0fc-489d-b84a-755736474dc5.png">
|
||||
|
||||
|
||||
5. In Google Workspace, configure the _Service provider details_.
|
||||
|
||||
- For _ACS URL_, use `https://<your_fleet_url>/api/v1/fleet/sso/callback` (eg. `https://fleet.example.com/api/v1/fleet/sso/callback`).
|
||||
- For Entity ID, use **the same unique identifier from step 4** (eg. `fleet.example.com`).
|
||||
- For _Name ID format_ choose `EMAIL`.
|
||||
- For _Name ID_ choose `Basic Information > Primary email`.
|
||||
- All other fields can be left blank.
|
||||
- For _ACS URL_, use `https://<your_fleet_url>/api/v1/fleet/sso/callback` (eg. `https://fleet.example.com/api/v1/fleet/sso/callback`).
|
||||
- For Entity ID, use **the same unique identifier from step 4** (eg. `fleet.example.com`).
|
||||
- For _Name ID format_ choose `EMAIL`.
|
||||
- For _Name ID_ choose `Basic Information > Primary email`.
|
||||
- All other fields can be left blank.
|
||||
|
||||
Click _Continue_ at the bottom of the page.
|
||||
Click _Continue_ at the bottom of the page.
|
||||
|
||||
<img width="1860" alt="Screen Shot 2021-09-15 at 5 36 56 PM" src="https://user-images.githubusercontent.com/575602/133530896-af561c81-ae54-4ee6-acca-5a6473b38b6b.png">
|
||||
|
||||
|
||||
6. Click _Finish_.
|
||||
|
||||
<img width="1904" alt="Screen Shot 2021-09-15 at 2 57 20 PM" src="https://user-images.githubusercontent.com/575602/133530932-9157c17b-ee84-46d9-9520-8faa864d872b.png">
|
||||
|
||||
|
||||
7. Click the down arrow on the _User access_ section of the app details page.
|
||||
|
||||
<img width="1904" alt="Screen Shot 2021-09-15 at 2 57 51 PM" src="https://user-images.githubusercontent.com/575602/133531007-a3a00a3f-65d4-46b0-9d39-eb74abda0901.png">
|
||||
|
||||
|
||||
8. Check _ON for everyone_. Click _Save_.
|
||||
|
||||
<img width="1904" alt="Screen Shot 2021-09-15 at 2 58 09 PM" src="https://user-images.githubusercontent.com/575602/133531039-93e29f0f-ef20-423b-bc31-8cef05a61b13.png">
|
||||
|
||||
|
||||
9. Enable SSO for a test user and try logging in. Note that Google sometimes takes a long time to propagate the SSO configuration, and it can help to try logging in to Fleet with an Incognito/Private window in the browser.
|
||||
|
||||
@@ -1616,7 +1618,7 @@ Feature flags on the server are controlled by environment variables prefixed wit
|
||||
|
||||
Enable by setting the environment variable `FLEET_BETA_SOFTWARE_INVENTORY=1`.
|
||||
|
||||
When enabled, Fleet will store a "software inventory" for hosts, updated along with the other host vitals. Note that it will take some time for the data to be available after setting this flag (it will be updated when the host details are next updated, configurable by [--osquery_detail_update_interval](#osquery_detail_update_interval)).
|
||||
When enabled, Fleet will store a "software inventory" for hosts, updated along with the other host vitals. Note that it will take some time for the data to be available after setting this flag (it will be updated when the host details are next updated, configurable by [--osquery_detail_update_interval](#osquery-detail-update-interval)).
|
||||
|
||||
This is currently feature flagged because we would like to evaluate the performance characteristics on larger deployments.
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 143 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 107 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 222 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 261 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 168 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 82 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 226 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 151 KiB |
+18
-4
@@ -22,10 +22,10 @@ For issues related to something that was ALREADY in Figma Fleet EE (current, dev
|
||||
|
||||
## Fleet docs
|
||||
|
||||
#### Adding a link to Fleet docs
|
||||
#### Adding a link to the Fleet docs
|
||||
You can link documentation pages to each other using relative paths. For example, in `docs/1-Using-Fleet/1-Fleet-UI.md`, you can link to `docs/1-Using-Fleet/9-Permissions.md` by writing `[permissions](./9-Permissions.md)`. This will be automatically transformed into the appropriate URL for `fleetdm.com/docs`.
|
||||
|
||||
However, the `fleetdm.com/docs` compilation process does not account for relative links to directories **outside** of `/docs`.
|
||||
However, the `fleetdm.com/docs` compilation process does not account for relative links to directories **outside** of `/docs`.
|
||||
Therefore, when adding a link to Fleet docs, it is important to always use the absolute file path.
|
||||
|
||||
#### Linking to a location on GitHub
|
||||
@@ -34,7 +34,7 @@ When adding a link to a location on GitHub that is outside of `/docs`, be sure t
|
||||
To do this, navigate to the file's location on GitHub, and press "y" to transform the URL into its canonical form.
|
||||
|
||||
#### How to fix a broken link
|
||||
For instances in which a broken link is discovered on fleetdm.com, check if the link is a relative link to a directory outside of `/docs`.
|
||||
For instances in which a broken link is discovered on fleetdm.com, check if the link is a relative link to a directory outside of `/docs`.
|
||||
|
||||
An example of a link that lives outside of `/docs` is:
|
||||
|
||||
@@ -42,10 +42,24 @@ An example of a link that lives outside of `/docs` is:
|
||||
../../tools/app/prometheus
|
||||
```
|
||||
|
||||
If the link lives outside `/docs`, head to the file's location on GitHub (in this case, [https://github.com/fleetdm/fleet/blob/main/tools/app/prometheus.yml)](https://github.com/fleetdm/fleet/blob/main/tools/app/prometheus.yml)), and press "y" to transform the URL into its canonical form ([https://github.com/fleetdm/fleet/blob/194ad5963b0d55bdf976aa93f3de6cabd590c97a/tools/app/prometheus.yml](https://github.com/fleetdm/fleet/blob/194ad5963b0d55bdf976aa93f3de6cabd590c97a/tools/app/prometheus.yml)). Replace the relative link with this link in the markdown file.
|
||||
If the link lives outside `/docs`, head to the file's location on GitHub (in this case, [https://github.com/fleetdm/fleet/blob/main/tools/app/prometheus.yml)](https://github.com/fleetdm/fleet/blob/main/tools/app/prometheus.yml)), and press "y" to transform the URL into its canonical form ([https://github.com/fleetdm/fleet/blob/194ad5963b0d55bdf976aa93f3de6cabd590c97a/tools/app/prometheus.yml](https://github.com/fleetdm/fleet/blob/194ad5963b0d55bdf976aa93f3de6cabd590c97a/tools/app/prometheus.yml)). Replace the relative link with this link in the markdown file.
|
||||
|
||||
> Note that the instructions above also apply to adding links in the Fleet handbook.
|
||||
|
||||
#### Adding an image to the Fleet docs
|
||||
Try to keep images in the docs at a minimum. Images can be a quick way to help a user understand a concept or direct them towards a specific UI element, but too many can make the documentation feel cluttered and more difficult to maintain.
|
||||
|
||||
When adding images to the Fleet documentation, follow these guidelines:
|
||||
- Keep the images as simple as possible to maintain (screenshots can get out of date quickly as UIs change)
|
||||
- Exclude unnecessary images. An image should be used to help emphasize information in the docs, not replace it.
|
||||
- Minimize images per doc page. More than one or two per page can get overwhelming, for doc maintainers and users.
|
||||
- The goal is for the docs to look good on every form factor, from 320px window width all the way up to infinity and beyond. Full window screenshots and images with too much padding on the sides will be less than the width of the user's screen. When adding a large image, make sure that it is easily readable at all widths.
|
||||
|
||||
Images can be added to the docs using the Markdown image link format, e.g. ``
|
||||
The images used in the docs live in `docs/images/`. Note that you must provide the url of the image in the Fleet Github repo for it to display properly on both Github and the Fleet website.
|
||||
|
||||
> Note that the instructions above also apply to adding images in the Fleet handbook.
|
||||
|
||||
## Manual QA
|
||||
|
||||
This living document outlines the manual quality assurance process conducted to ensure each release of Fleet meets organization standards.
|
||||
|
||||
@@ -427,6 +427,9 @@
|
||||
border-radius: 12px;
|
||||
text-decoration: none;
|
||||
}
|
||||
ol {
|
||||
padding-inline-start: 16px;
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user