Files
threshold/website/content/docs/commands/cache/start.mdx
T

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

49 lines
1.8 KiB
Plaintext
Raw Normal View History

---
layout: docs
2024-05-22 11:11:48 -07:00
page_title: cache start - Command
description: |-
2024-05-22 11:11:48 -07:00
The "cache start" command lets you manually start the Boundary cache and customize the behavior of the local cache.
---
2024-05-22 11:11:48 -07:00
# cache start
2024-05-22 11:11:48 -07:00
Command: `boundary cache start`
2024-05-22 11:11:48 -07:00
The `boundary cache start` command lets you manually start the Boundary cache and customize the behavior of the local cache.
## Example
2024-05-22 11:11:48 -07:00
The following command starts the Boundary cache in the background:
```shell-session
2024-05-22 11:11:48 -07:00
$ boundary cache start -background
```
## Usage
<CodeBlockConfig hideClipboard>
```shell-session
2024-05-22 11:11:48 -07:00
$ boundary cache start [options] [args]
```
</CodeBlockConfig>
### Command options
2024-05-22 11:11:48 -07:00
- `background` - Starts the Boundary cache in the background.
The default value is `false`.
2024-05-22 11:11:48 -07:00
By default, the cache starts in the foreground.
- `log-format=<string>` - Specifies the log format, mostly as a fallback for events.
Supported values are `standard` and `json`.
- `max-search-refresh-timeout=<duration>` - If a search request triggers a best effort refresh, this value specifies how long the refresh should run before time out.
In the event of a timeout, Boundary uses the stale data that is currently in the cache.
The default value is 7 seconds.
- `max-search-staleness=<duration>` - The amount of time that can pass since the last refresh before the client cache causes a blocking refresh.
The blocking refresh occurs when you perform the `boundary search` command.
It requires Boundary to refresh the local cache using the control plane.
The default value is 30 seconds.
- `refresh-interval` - A duration that specifies how frequently the client cache should query Boundary for changes to sessions and targets.
Note that Boundary only searches sessions and targets that the user who ran the command has access to.
2024-05-22 11:11:48 -07:00
@include 'cmd-option-note.mdx'