-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5710 from influxdata/ga-admin
Move admin UI assets to the admin service directory
- Loading branch information
Showing
22 changed files
with
43 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# InfluxDB Admin Interface | ||
|
||
This is the built-in admin interface that ships with InfluxDB. The service is intended to have little overhead and minimal preprocessing steps. | ||
|
||
## How it works | ||
|
||
Static assets, located in the `assets` directory, are embedded in the `influxd` binary and served from memory using a simple fileserver. | ||
|
||
The admin UI itself uses [React](https://github.com/facebook/react) for the user interface to interact directly with the InfluxDB API, usually running on port `8086`. | ||
|
||
## Building | ||
|
||
The only step required to bundle the admin UI with InfluxDB is to create a compressed file system using `statik` as follows: | ||
|
||
``` | ||
go get github.com/rakyll/statik # make sure $GOPATH/bin is listed in your PATH | ||
cd $GOPATH/src/github.com/influxdata/influxdb | ||
go generate github.com/influxdata/influxdb/services/admin | ||
``` | ||
|
||
The `go generate ./...` command will run `statik` to generate the `statik/statik.go` file. The generated `go` file will embed the admin interface assets into the InfluxDB binary. | ||
|
||
This step should be run before submitting any pull requests which include modifications to admin interface assets. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
package admin // import "github.com/influxdata/influxdb/services/admin" | ||
|
||
//go:generate statik -src=assets | ||
//go:generate go fmt statik/statik.go |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
Please note that these files are embedded into the `influxd` binary using the | ||
[statik](https://github.com/rakyll/statik) tool. `go generate` needs to be run | ||
whenever there are changes made to files in this directory. See the admin | ||
interface readme for more information. |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,3 @@ | ||
Please note that this file is automatically generated by the | ||
[statik](https://github.com/rakyll/statik) tool, and should not be | ||
updated directly. For more information, please see the Admin UI readme | ||
available at `/shared/admin/README.md`. | ||
updated directly. See the Admin UI readme for more information. |
Large diffs are not rendered by default.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.