Nail/fission-src
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add support for generating CRD docs (#2273)

Browse Source 
* Add support for generating CRD docs
* Correct typos in custom resource definitions

Signed-off-by: Sanket Sudake <sanketsudake@gmail.com>
This commit is contained in:
Sanket Sudake
2021-11-30 15:54:53 +05:30
committed by GitHub
parent 24737e8958
commit fe0c1e3683
11 changed files with 48 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files
crds/v1/fission.io_environments.yaml
+1 -1
View File
@@ -9399,7 +9399,7 @@ spec:
format: int64
type: integer
version:
description: "Version is the Environment API version \n Version \"1\" allows user to run code snippet in a file and it's supported by most of environments except tensorflow-serving. \n Version \"2\" supports downloading and compiling user function if source archive is not empty. \n Version \"3\" is almost the same with v2, but you're able to control the size of pre-warm pool of the environment."
description: "Version is the Environment API version \n Version \"1\" allows user to run code snippet in a file, and it's supported by most of the environments except tensorflow-serving. \n Version \"2\" supports downloading and compiling user function if source archive is not empty. \n Version \"3\" is almost the same with v2, but you're able to control the size of pre-warm pool of the environment."
type: integer
required:
- runtime
crds/v1/fission.io_functions.yaml
+2 -2
View File
@@ -41,7 +41,7 @@ spec:
description: ExecutionStrategy specifies low-level parameters for function execution, such as the number of instances.
properties:
ExecutorType:
description: "ExecutorType is the executor type of a function used. Defaults to \"poolmgr\". \n Available value: - poolmgr - newdeploy - container"
description: "ExecutorType is the executor type of function used. Defaults to \"poolmgr\". \n Available value: - poolmgr - newdeploy - container"
type: string
MaxScale:
description: This is only for newdeploy to set up maximum replicas of deployment.
@@ -57,7 +57,7 @@ spec:
type: integer
type: object
StrategyType:
description: StrategyType is the strategy type of a function. Now it only supports 'execution'.
description: StrategyType is the strategy type of function. Now it only supports 'execution'.
type: string
type: object
concurrency:
crds/v1/fission.io_httptriggers.yaml
+3 -3
View File
@@ -33,7 +33,7 @@ spec:
description: HTTPTriggerSpec is for router to expose user functions at the given URL path.
properties:
createingress:
description: If CreateIngress is true, router will create a ingress definition.
description: If CreateIngress is true, router will create an ingress definition.
type: boolean
functionref:
description: FunctionReference is a reference to the target function.
@@ -58,12 +58,12 @@ spec:
description: 'TODO: remove this field since we have IngressConfig already Deprecated: the original idea of this field is not for setting Ingress. Since we have IngressConfig now, remove Host after couple releases.'
type: string
ingressconfig:
description: 'TODO: make IngressConfig a independent Fission resource IngressConfig for router to set up Ingress.'
description: 'TODO: make IngressConfig an independent Fission resource IngressConfig for router to set up Ingress.'
properties:
annotations:
additionalProperties:
type: string
description: Annotations will be add to metadata when creating Ingress.
description: Annotations will be added to metadata when creating Ingress.
nullable: true
type: object
host:
crds/v1/fission.io_packages.yaml
+2 -2
View File
@@ -50,7 +50,7 @@ spec:
type: string
type: object
literal:
description: Literal contents of the package. Can be used for encoding packages below TODO (256KB?) size.
description: Literal contents of the package. Can be used for encoding packages below TODO (256 KB?) size.
format: byte
type: string
type:
@@ -84,7 +84,7 @@ spec:
type: string
type: object
literal:
description: Literal contents of the package. Can be used for encoding packages below TODO (256KB?) size.
description: Literal contents of the package. Can be used for encoding packages below TODO (256 KB?) size.
format: byte
type: string
type: