feat(coder): add authz_querier experiment (#5858)

* feat(coderd): add authz_querier experiment

* coderdtest: wire up authz_querier

* wire up AuthzQuerier in coderd

* remove things that do not yet exist in this timeline

* add newline

* comment unreachable code
This commit is contained in:
Cian Johnston
2023-01-25 21:35:53 +00:00
committed by GitHub
parent 1cd5f38cb0
commit 8735f51047
8 changed files with 66 additions and 11 deletions
+10 -1
View File
@@ -430,7 +430,7 @@ const docTemplate = `{
"schema": {
"type": "array",
"items": {
"type": "string"
"$ref": "#/definitions/codersdk.Experiment"
}
}
}
@@ -6195,6 +6195,15 @@ const docTemplate = `{
}
}
},
"codersdk.Experiment": {
"type": "string",
"enum": [
"authz_querier"
],
"x-enum-varnames": [
"ExperimentAuthzQuerier"
]
},
"codersdk.Feature": {
"type": "object",
"properties": {
+6 -1
View File
@@ -364,7 +364,7 @@
"schema": {
"type": "array",
"items": {
"type": "string"
"$ref": "#/definitions/codersdk.Experiment"
}
}
}
@@ -5528,6 +5528,11 @@
}
}
},
"codersdk.Experiment": {
"type": "string",
"enum": ["authz_querier"],
"x-enum-varnames": ["ExperimentAuthzQuerier"]
},
"codersdk.Feature": {
"type": "object",
"properties": {
+9 -1
View File
@@ -154,6 +154,14 @@ func New(options *Options) *API {
if options == nil {
options = &Options{}
}
experiments := initExperiments(options.Logger, options.DeploymentConfig.Experiments.Value, options.DeploymentConfig.Experimental.Value)
// TODO: remove this once we promote authz_querier out of experiments.
if experiments.Enabled(codersdk.ExperimentAuthzQuerier) {
panic("Coming soon!")
// if _, ok := (options.Database).(*authzquery.AuthzQuerier); !ok {
// options.Database = authzquery.NewAuthzQuerier(options.Database, options.Authorizer)
// }
}
if options.AppHostname != "" && options.AppHostnameRegex == nil || options.AppHostname == "" && options.AppHostnameRegex != nil {
panic("coderd: both AppHostname and AppHostnameRegex must be set or unset")
}
@@ -222,7 +230,7 @@ func New(options *Options) *API {
},
metricsCache: metricsCache,
Auditor: atomic.Pointer[audit.Auditor]{},
Experiments: initExperiments(options.Logger, options.DeploymentConfig.Experiments.Value, options.DeploymentConfig.Experimental.Value),
Experiments: experiments,
}
if options.UpdateCheckOptions != nil {
api.updateChecker = updatecheck.New(
+9
View File
@@ -21,6 +21,7 @@ import (
"net/http"
"net/http/httptest"
"net/url"
"os"
"regexp"
"strconv"
"strings"
@@ -176,6 +177,14 @@ func NewOptions(t *testing.T, options *Options) (func(http.Handler), context.Can
if options.Database == nil {
options.Database, options.Pubsub = dbtestutil.NewDB(t)
}
// TODO: remove this once we're ready to enable authz querier by default.
if strings.Contains(os.Getenv("CODER_EXPERIMENTS_TEST"), "authz_querier") {
panic("Coming soon!")
// if options.Authorizer != nil {
// options.Authorizer = &RecordingAuthorizer{}
// }
// options.Database = authzquery.NewAuthzQuerier(options.Database, options.Authorizer)
}
if options.DeploymentConfig == nil {
options.DeploymentConfig = DeploymentConfig(t)
}
+6 -2
View File
@@ -9,8 +9,12 @@ import (
type Experiment string
const (
// Add new experiments here!
// ExperimentExample Experiment = "example"
// ExperimentAuthzQuerier is an internal experiment that enables the ExperimentAuthzQuerier
// interface for all RBAC operations. NOT READY FOR PRODUCTION USE.
ExperimentAuthzQuerier Experiment = "authz_querier"
// Add new experiments here!
// ExperimentExample Experiment = "example"
)
var (
+10 -4
View File
@@ -1072,17 +1072,23 @@ curl -X GET http://coder-server:8080/api/v2/experiments \
> 200 Response
```json
["string"]
["authz_querier"]
```
### Responses
| Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | --------------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of string |
| Status | Meaning | Description | Schema |
| ------ | ------------------------------------------------------- | ----------- | ------------------------------------------------------------- |
| 200 | [OK](https://tools.ietf.org/html/rfc7231#section-6.3.1) | OK | array of [codersdk.Experiment](schemas.md#codersdkexperiment) |
<h3 id="get-experiments-responseschema">Response Schema</h3>
Status Code **200**
| Name | Type | Required | Restrictions | Description |
| -------------- | ----- | -------- | ------------ | ----------- |
| `[array item]` | array | false | | |
To perform this operation, you must be authenticated. [Learn more](authentication.md).
## Update check
+14
View File
@@ -2439,6 +2439,20 @@ CreateParameterRequest is a structure used to create a new parameter value for a
| `trial` | boolean | false | | |
| `warnings` | array of string | false | | |
## codersdk.Experiment
```json
"authz_querier"
```
### Properties
#### Enumerated Values
| Value |
| --------------- |
| `authz_querier` |
## codersdk.Feature
```json
+2 -2
View File
@@ -1097,8 +1097,8 @@ export const Entitlements: Entitlement[] = [
]
// From codersdk/experiments.go
export type Experiment = never
export const Experiments: Experiment[] = []
export type Experiment = "authz_querier"
export const Experiments: Experiment[] = ["authz_querier"]
// From codersdk/features.go
export type FeatureName =