Skip to content

Commit

Permalink
docs: add context to reference.md
Browse files Browse the repository at this point in the history
Signed-off-by: Kumar Mallikarjuna <kumarmallikarjuna.work@gmail.com>
  • Loading branch information
kumar-mallikarjuna committed Sep 11, 2024
1 parent e3392e1 commit bc39e98
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions docs/testing/reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,17 +64,18 @@ kubeconfig: foo.kubeconfig

Supported settings:

Field | Type | Description
---------|---------------------------|---------------------------------------------------------------------
apply | list of files | A list of files to apply as part of this step. Specified path is relative to that in which the step occurs.
assert | list of files | A list of files to assert as part of this step. See documentation for [asserts and errors](asserts-errors.md) for more information. Specified path is relative to that in which the step occurs.
error | list of files | A list of files to error as part of this step. See documentation for [asserts and errors](asserts-errors.md) for more information. Specified path is relative to that in which the step occurs.
delete | list of object references | A list of objects to delete, if they do not already exist, at the beginning of the test step. The test harness will wait for the objects to be successfully deleted before applying the objects in the step.
index | int | Override the test step's index.
Field | Type | Description
---------|-------------------------------|---------------------------------------------------------------------
apply | list of files | A list of files to apply as part of this step. Specified path is relative to that in which the step occurs.
assert | list of files | A list of files to assert as part of this step. See documentation for [asserts and errors](asserts-errors.md) for more information. Specified path is relative to that in which the step occurs.
error | list of files | A list of files to error as part of this step. See documentation for [asserts and errors](asserts-errors.md) for more information. Specified path is relative to that in which the step occurs.
delete | list of object references | A list of objects to delete, if they do not already exist, at the beginning of the test step. The test harness will wait for the objects to be successfully deleted before applying the objects in the step.
index | int | Override the test step's index.
commands | list of [Commands](#commands) | Commands to run prior at the beginning of the test step.
kubeconfig | string | The Kubeconfig file to use to run the included steps(s).
kubeconfigLoading | string | Specifies the mode for loading Kubeconfig and making a cluster connection: `Eager` (when loading the test definition) or `Lazy` (right before executing the step, makes it possible to generate the Kubeconfig in a preceding step). Defaults to `Eager`.
unitTest | bool | Indicates if the step is a unit test, safe to run without a real Kubernetes cluster.
kubeconfig | string | The Kubeconfig file to use to run the included steps(s).
kubeconfigLoading | string | Specifies the mode for loading Kubeconfig and making a cluster connection: `Eager` (when loading the test definition) or `Lazy` (right before executing the step, makes it possible to generate the Kubeconfig in a preceding step). Defaults to `Eager`.
context | string | Specifies the context to use from the Kubeconfig.
unitTest | bool | Indicates if the step is a unit test, safe to run without a real Kubernetes cluster.


Object Reference:
Expand Down

0 comments on commit bc39e98

Please # to comment.