From de336e39ef66af1dd006870d25275fe1903cc8ca Mon Sep 17 00:00:00 2001 From: Deepesh Pathak Date: Sun, 14 Jun 2020 13:53:48 +0530 Subject: [PATCH] examples: update example configs and manifests Signed-off-by: Deepesh Pathak --- README.md | 2 +- ROADMAP.md | 1 + _examples/sample.agent.config.yaml | 11 +++++++++-- _examples/sample.apiserver.config.yaml | 10 ++++++---- _examples/sample.xenectl.yml | 2 ++ docs/README.md | 2 +- mkdocs.yml | 6 +++--- 7 files changed, 23 insertions(+), 11 deletions(-) create mode 100644 _examples/sample.xenectl.yml diff --git a/README.md b/README.md index 74f8417..9443a53 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ You can start with setting up Xene on your system and try solving a few bugs lis ## Documentation - [API Docs](https://xene-api-docs.netlify.app/apidocs.html) -- [Roadmap](/ROADMAP) +- [Roadmap](/ROADMAP.md) - [Xene Documentation](https://xene-api-docs.netlify.app/) - [Go Doc](https://pkg.go.dev/github.com/fristonio/xene) - [Getting Started](/docs/GettingStarted.md) diff --git a/ROADMAP.md b/ROADMAP.md index b2e7588..884dd04 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -14,3 +14,4 @@ - [ ] Secret embedding in workflow specification. - [ ] Executor pool for running pipeline executors. +- [ ] Introduce logging plugins to agents, like save log to S3 lake. diff --git a/_examples/sample.agent.config.yaml b/_examples/sample.agent.config.yaml index 28ae8e4..01e28ec 100644 --- a/_examples/sample.agent.config.yaml +++ b/_examples/sample.agent.config.yaml @@ -1,7 +1,14 @@ agent: + name: default.agent.xene host: "127.0.0.1" apiServer: "http://localhost:6060" - apiAuthToken: xxxxxxxxxxx + apiAuthToken: "xxx" address: "http://127.0.0.1:6061" - insecure: true + insecure: false + serverName: agent.xene.io jwtSecret: xxxxxxxxxxx + keyFile: ./contrib/certs/server.gen/server-key.pem + certFile: ./contrib/certs/server.gen/server.pem + rootCACert: ./contrib/certs/ca.gen/ca.pem + clientKeyFile: ./contrib/certs/client.gen/client-key.pem + clientCertFile: ./contrib/certs/client.gen/client.pem diff --git a/_examples/sample.apiserver.config.yaml b/_examples/sample.apiserver.config.yaml index 10afc8c..7da25d1 100644 --- a/_examples/sample.apiserver.config.yaml +++ b/_examples/sample.apiserver.config.yaml @@ -1,13 +1,15 @@ apiserver: host: "127.0.0.1" verboseLogs: true - jwtSecret: xxxxxxxx + jwtSecret: "xxxxx" + allowedDomains: + - "ec.iitr.ac.in" oauth: google: name: google - clientID: xxxxxx - clientSecret: xxxxxxx - redirectURL: "http://localhost:6060/oauth/google/redirect" + clientID: "xxxx.apps.googleusercontent.com" + clientSecret: "xxxx" + redirectURL: "http://localhost:3000/oauth/callback" scopes: - profile - email diff --git a/_examples/sample.xenectl.yml b/_examples/sample.xenectl.yml new file mode 100644 index 0000000..a7376c4 --- /dev/null +++ b/_examples/sample.xenectl.yml @@ -0,0 +1,2 @@ +apiServerAddr: 'http://127.0.0.1:6060' +authToken: "xxxxxxx" diff --git a/docs/README.md b/docs/README.md index 78f38e5..5324dfb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -12,7 +12,7 @@ Xene is built with Golang with a focus on performance, resiliency, and simplicit ## Documentation - [API Docs](https://xene-api-docs.netlify.app/apidocs.html) -- [Roadmap](/ROADMAP) +- [Roadmap](/ROADMAP.md) - [Xene Documentation](https://xene-api-docs.netlify.app/) - [Go Doc](https://pkg.go.dev/github.com/fristonio/xene) - [Getting Started](/docs/GettingStarted.md) diff --git a/mkdocs.yml b/mkdocs.yml index 3a757e0..b03d1fb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,11 +2,11 @@ site_name: Xene nav: - Home: README.md - - CmdRef: cmdref/xene.md - - xenectl: cmdref/xenectl/xenectl.md - - Design: design/README.md + - Architecture: design/README.md - APIDocs: /apidocs.html - GoDoc: http://pkg.go.dev/github.com/fristonio/xene + - xene: cmdref/xene.md + - xenectl: cmdref/xenectl/xenectl.md theme: bootstrap4