* Provisioning: Define secrets service
* Provisioning: Create and store secrets service
* Provisioning: Define safepath
* Provisioning: Define the repository
* Identity: Support a provisioning service
* Provisioning: Define a job queue
* Chore: Regen code
* Provisioning: Show progress more often
Co-Authored-By: Ryan McKinley <ryantxu@gmail.com>
* Provisioning: Rename hash field to lastRef
Co-Authored-By: =?UTF-8?q?Roberto=20Jim=C3=A9nez=20S=C3=A1nchez?= <roberto.jimenez@grafana.com>
* Provisioning: Workflows as write access
Co-Authored-By: Ryan McKinley <ryantxu@gmail.com>
* Provisioning: Regen OpenAPI snapshot
* Provisioning: Update tests to match new fields
---------
Co-authored-by: Ryan McKinley <ryantxu@gmail.com>
Co-authored-by: =?UTF-8?q?Roberto=20Jim=C3=A9nez=20S=C3=A1nchez?= <roberto.jimenez@grafana.com>
Description:"Workflow allowed for changes to the repository. The order is relevant for defining the precedence of the workflows. Possible values: pull-request, branch, push.",
Type:[]string{"array"},
Items:&spec.SchemaOrArray{
Schema:&spec.Schema{
SchemaProps:spec.SchemaProps{
Default:"",
Type:[]string{"string"},
Format:"",
Enum:[]interface{}{"branch","push"},
},
},
},
},
},
"branchWorkflow":{
SchemaProps:spec.SchemaProps{
Description:"Whether we should commit to change branches and use a Pull Request flow to achieve this. By default, this is false (i.e. we will commit straight to the main branch).",
Type:[]string{"boolean"},
Format:"",
},
},
"generateDashboardPreviews":{
SchemaProps:spec.SchemaProps{
Description:"Whether we should show dashboard previews for pull requests. By default, this is false (i.e. we will not create previews).",
Description:"ReadOnly repository does not allow any write commands",
Default:false,
Type:[]string{"boolean"},
Format:"",
Description:"UI driven Workflow that allow changes to the contends of the repository. The order is relevant for defining the precedence of the workflows. When empty, the repository does not support any edits (eg, readonly)",
// We clean early to make the HasPrefix check be sensible after path.Join does a Clean for us.
prefix=replaceOSSeparators(path.Clean(prefix))
iflen(elem)==0{
returnprefix,nil
}
fori,e:=rangeelem{
// We don't use Clean here because the output of path.Join will clean for us.
elem[i]=replaceOSSeparators(e)
}
subPath:=path.Join(elem...)// performs a Clean after joining
completePath:=path.Join(prefix,subPath)
if!strings.HasPrefix(completePath,prefix){
return"",ErrUnsafePathTraversal
}
returncompletePath,nil
}
// Performs a [path.Clean] on the path, as well as replacing its OS separators.
// Note that this does no effort to ensure the paths are safe to use. It only cleans them.
funcClean(pstring)string{
returnpath.Clean(replaceOSSeparators(p))
}
// osSeparator is declared as a var here only to ensure we can change it in tests.
varosSeparator=os.PathSeparator
// This replaces the OS separator with a slash.
// All OSes we target (Linux, macOS, and Windows) support forward-slashes in path traversals, as such it's simpler to use the same character everywhere.
// BSDs do as well (even though they're not a target as of writing).
"description":"allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.",
"schema":{
"type":"boolean",
"uniqueItems":true
}
},
{
"name":"continue",
"in":"query",
"description":"The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".\n\nThis field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
"schema":{
"type":"string",
"uniqueItems":true
}
},
{
"name":"fieldSelector",
"in":"query",
"description":"A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"schema":{
"type":"string",
"uniqueItems":true
}
},
{
"name":"labelSelector",
"in":"query",
"description":"A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"schema":{
"type":"string",
"uniqueItems":true
}
},
{
"name":"limit",
"in":"query",
"description":"limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
"schema":{
"type":"integer",
"uniqueItems":true
}
},
{
"name":"pretty",
"in":"query",
"description":"If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).",
"schema":{
"type":"string",
"uniqueItems":true
}
},
{
"name":"resourceVersion",
"in":"query",
"description":"resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
"schema":{
"type":"string",
"uniqueItems":true
}
},
{
"name":"resourceVersionMatch",
"in":"query",
"description":"resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
"schema":{
"type":"string",
"uniqueItems":true
}
},
{
"name":"sendInitialEvents",
"in":"query",
"description":"`sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.\n\nWhen `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan\n is interpreted as \"data at least as new as the provided `resourceVersion`\"\n and the bookmark event is send when the state is synced\n to a `resourceVersion` at least as fresh as the one provided by the ListOptions.\n If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the\n bookmark event is send when the state is synced at least to the moment\n when request started being processed.\n- `resourceVersionMatch` set to any other value or unset\n Invalid error is returned.\n\nDefaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise.",
"schema":{
"type":"boolean",
"uniqueItems":true
}
},
{
"name":"timeoutSeconds",
"in":"query",
"description":"Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
"schema":{
"type":"integer",
"uniqueItems":true
}
},
{
"name":"watch",
"in":"query",
"description":"Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"description":"allowWatchBookmarks requests watch events with type \"BOOKMARK\". Servers that do not implement bookmarks may ignore this flag and bookmarks are sent at the server's discretion. Clients should not assume bookmarks are returned at any specific interval, nor may they assume the server will send any BOOKMARK event during a session. If this is not a watch, this field is ignored.",
"schema":{
"type":"boolean",
"uniqueItems":true
}
},
{
"name":"continue",
"in":"query",
"description":"The continue option should be set when retrieving more results from the server. Since this value is server defined, clients may only use the continue value from a previous query result with identical query parameters (except for the value of continue) and the server may reject a continue value it does not recognize. If the specified continue value is no longer valid whether due to expiration (generally five to fifteen minutes) or a configuration change on the server, the server will respond with a 410 ResourceExpired error together with a continue token. If the client needs a consistent list, it must restart their list without the continue field. Otherwise, the client may send another list request with the token received with the 410 error, the server will respond with a list starting from the next key, but from the latest snapshot, which is inconsistent from the previous list results - objects that are created, modified, or deleted after the first list request will be included in the response, as long as their keys are after the \"next key\".\n\nThis field is not supported when watch is true. Clients may start a watch from the last resourceVersion value returned by the server and not miss any modifications.",
"schema":{
"type":"string",
"uniqueItems":true
}
},
{
"name":"fieldSelector",
"in":"query",
"description":"A selector to restrict the list of returned objects by their fields. Defaults to everything.",
"schema":{
"type":"string",
"uniqueItems":true
}
},
{
"name":"labelSelector",
"in":"query",
"description":"A selector to restrict the list of returned objects by their labels. Defaults to everything.",
"schema":{
"type":"string",
"uniqueItems":true
}
},
{
"name":"limit",
"in":"query",
"description":"limit is a maximum number of responses to return for a list call. If more items exist, the server will set the `continue` field on the list metadata to a value that can be used with the same initial query to retrieve the next set of results. Setting a limit may return fewer than the requested amount of items (up to zero items) in the event all requested objects are filtered out and clients should only use the presence of the continue field to determine whether more results are available. Servers may choose not to support the limit argument and will return all of the available results. If limit is specified and the continue field is empty, clients may assume that no more results are available. This field is not supported if watch is true.\n\nThe server guarantees that the objects returned when using continue will be identical to issuing a single list call without a limit - that is, no objects created, modified, or deleted after the first request is issued will be included in any subsequent continued requests. This is sometimes referred to as a consistent snapshot, and ensures that a client that is using limit to receive smaller chunks of a very large result can ensure they see all possible objects. If objects are updated during a chunked list the version of the object that was present at the time the first list result was calculated is returned.",
"schema":{
"type":"integer",
"uniqueItems":true
}
},
{
"name":"namespace",
"in":"path",
"description":"object name and auth scope, such as for teams and projects",
"required":true,
"schema":{
"type":"string",
"uniqueItems":true
}
},
{
"name":"pretty",
"in":"query",
"description":"If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).",
"schema":{
"type":"string",
"uniqueItems":true
}
},
{
"name":"resourceVersion",
"in":"query",
"description":"resourceVersion sets a constraint on what resource versions a request may be served from. See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
"schema":{
"type":"string",
"uniqueItems":true
}
},
{
"name":"resourceVersionMatch",
"in":"query",
"description":"resourceVersionMatch determines how resourceVersion is applied to list calls. It is highly recommended that resourceVersionMatch be set for list calls where resourceVersion is set See https://kubernetes.io/docs/reference/using-api/api-concepts/#resource-versions for details.\n\nDefaults to unset",
"schema":{
"type":"string",
"uniqueItems":true
}
},
{
"name":"sendInitialEvents",
"in":"query",
"description":"`sendInitialEvents=true` may be set together with `watch=true`. In that case, the watch stream will begin with synthetic events to produce the current state of objects in the collection. Once all such events have been sent, a synthetic \"Bookmark\" event will be sent. The bookmark will report the ResourceVersion (RV) corresponding to the set of objects, and be marked with `\"k8s.io/initial-events-end\": \"true\"` annotation. Afterwards, the watch stream will proceed as usual, sending watch events corresponding to changes (subsequent to the RV) to objects watched.\n\nWhen `sendInitialEvents` option is set, we require `resourceVersionMatch` option to also be set. The semantic of the watch request is as following: - `resourceVersionMatch` = NotOlderThan\n is interpreted as \"data at least as new as the provided `resourceVersion`\"\n and the bookmark event is send when the state is synced\n to a `resourceVersion` at least as fresh as the one provided by the ListOptions.\n If `resourceVersion` is unset, this is interpreted as \"consistent read\" and the\n bookmark event is send when the state is synced at least to the moment\n when request started being processed.\n- `resourceVersionMatch` set to any other value or unset\n Invalid error is returned.\n\nDefaults to true if `resourceVersion=\"\"` or `resourceVersion=\"0\"` (for backward compatibility reasons) and to false otherwise.",
"schema":{
"type":"boolean",
"uniqueItems":true
}
},
{
"name":"timeoutSeconds",
"in":"query",
"description":"Timeout for the list/watch call. This limits the duration of the call, regardless of any activity or inactivity.",
"schema":{
"type":"integer",
"uniqueItems":true
}
},
{
"name":"watch",
"in":"query",
"description":"Watch for changes to the described resources and return them as a stream of add, update, and remove notifications. Specify resourceVersion.",
"description":"object name and auth scope, such as for teams and projects",
"required":true,
"schema":{
"type":"string",
"uniqueItems":true
}
},
{
"name":"pretty",
"in":"query",
"description":"If 'true', then the output is pretty printed. Defaults to 'false' unless the user-agent indicates a browser or command-line HTTP tool (curl and wget).",
"description":"The branch to use in the repository. By default, this is the main branch.",
"type":"string"
},
"branchWorkflow":{
"description":"Whether we should commit to change branches and use a Pull Request flow to achieve this. By default, this is false (i.e. we will commit straight to the main branch).",
"type":"boolean"
"description":"The branch to use in the repository.",
"type":"string",
"default":""
},
"encryptedToken":{
"description":"Token for accessing the repository, but encrypted. This is not possible to read back to a user decrypted.",
"description":"Workflow allowed for changes to the repository. The order is relevant for defining the precedence of the workflows. Possible values: pull-request, branch, push.",
"description":"The repository name and type are stored as labels",
"type":"object",
"properties":{
"apiVersion":{
"description":"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"type":"string"
},
"kind":{
"description":"Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"description":"APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
"description":"Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
"description":"Possible enum values:\n - `\"export\"` Export from grafana into the remote repository\n - `\"pr\"` Update a pull request -- send preview images, links etc\n - `\"sync\"` Sync the remote branch with the grafana instance",
"type":"string",
"default":"",
"enum":[
"export",
"pr",
"sync"
]
},
"export":{
"description":"Required when the action is `export`",
"description":"Optional value 0-100 that can be set while running",
"type":"number",
"format":"double"
},
"started":{
"type":"integer",
"format":"int64"
},
"state":{
"description":"Possible enum values:\n - `\"error\"` Finished with errors\n - `\"pending\"` Job has been submitted, but not processed yet\n - `\"success\"` Finished with success\n - `\"working\"` The job is running",
"description":"When this code is changed, make sure to update the code generation. As of writing, this can be done via the hack dir in the root of the repo: ./hack/update-codegen.sh provisioning If you've opened the generated files in this dir at some point in VSCode, you may also have to re-open them to clear errors.",
"type":"object",
@ -1472,7 +2121,7 @@
"type":"object",
"required":[
"title",
"readOnly",
"workflows",
"sync",
"type"
],
@ -1497,11 +2146,6 @@
}
]
},
"readOnly":{
"description":"ReadOnly repository does not allow any write commands",
"type":"boolean",
"default":false
},
"sync":{
"description":"Sync settings -- how values are pulled from the repository into grafana",
"default":{},
@ -1524,6 +2168,18 @@
"github",
"local"
]
},
"workflows":{
"description":"UI driven Workflow that allow changes to the contends of the repository. The order is relevant for defining the precedence of the workflows. When empty, the repository does not support any edits (eg, readonly)",
Mariell Hoversholm
3 months ago
committed by