Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Populate FAQ with more questions from Weave Cloud Notion's knowledge base #3447

Merged
merged 1 commit into from
Nov 26, 2018
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions site/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,3 +55,24 @@ OSS Scope has no user concept, this is only available in Weave Cloud. To limit t
-app.basicAuth.username string
Username for basic authentication (default "admin")
```

## ARM Support

- It required patches, @adivyoseph (on [#scope](https://weave-community.slack.com/messages/scope/)) had done some work on this.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/it required patches/it requires further work/ ?

- [#2110](https://github.com/weaveworks/scope/issues/2110) says that scope's CI builds ARM32 (but not ARM64) for test-builds at least.
- @errordeveloper says: It should be easy to add arm64 in CI, You can try and enable builds in ci on a branch.. In theory, you just need to build for `GOARCH=arm64`.

## Data Storage

OSS Scope reports aren't persistent and the probe keeps the last 15 seconds of metrics in memory.
Copy link
Contributor

@2opremio 2opremio Nov 27, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The OSS codebase supports persistent reports as well, but it doesn't document it well nor helps you setting up the infrastructure required to do so.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that's a good point, I will update the docs!


## API Endpoints

Scope exposes the following endpoints that can be used by external monitoring services.

- `/api` - Scope status and configuration
- `/api/probes` - basic status of Scope probes
- `/api/report` - returns a full JSON report
- `/api/topology` - information on all topologies
- `/api/topology/[TOPOLOGY]` - information on all nodes belonging to `TOPOLOGY` topology
- `/api/topology/[TOPOLOGY]/[NODE_ID]` - information on specific node `NODE_ID` in topology `TOPOLOGY` (currently `NODE_ID` must be an internal Scope node ID obtained from the URL field `selectedNodeId` when selecting that node in the UI - see [#3122](https://github.com/weaveworks/scope/issues/3122) for a proposal of a better solution)