From b056e1c4fae8fa6cd04227aeccb8a5b8099968d0 Mon Sep 17 00:00:00 2001 From: pmahindrakar-oss <77798312+pmahindrakar-oss@users.noreply.github.com> Date: Fri, 21 May 2021 11:45:44 +0530 Subject: [PATCH] Added flyteidl documentation (#167) * Added flyteidl documentation Signed-off-by: Prafulla Mahindrakar * Generated doc requirements and updated CI to not generate docs for now Signed-off-by: Prafulla Mahindrakar * Moved to rst file for events Signed-off-by: Prafulla Mahindrakar * Moved to rst file for all index files Signed-off-by: Prafulla Mahindrakar (cherry picked from commit 6dc3c4785dc95b05412a9bec2377016cf16b5ea8) * Added tmp doc generation step for getting doc dependencies Signed-off-by: Prafulla Mahindrakar --- flyteidl/.github/workflows/verification.yml | 14 - flyteidl/.gitignore | 3 +- flyteidl/Makefile | 21 +- flyteidl/conf.py | 18 +- flyteidl/doc-requirements.in | 2 + flyteidl/doc-requirements.txt | 13 +- .../flyteidl/admin/common.proto.rst | 800 -- .../flyteidl/admin/event.proto.rst | 182 - .../flyteidl/admin/execution.proto.rst | 761 -- .../gen/pb-protodoc/flyteidl/admin/index.rst | 27 - .../flyteidl/admin/launch_plan.proto.rst | 480 - .../admin/matchable_resource.proto.rst | 424 - .../flyteidl/admin/node_execution.proto.rst | 513 - .../flyteidl/admin/notification.proto.rst | 57 - .../flyteidl/admin/project.proto.rst | 244 - .../admin/project_domain_attributes.proto.rst | 184 - .../flyteidl/admin/schedule.proto.rst | 140 - .../pb-protodoc/flyteidl/admin/task.proto.rst | 167 - .../flyteidl/admin/task_execution.proto.rst | 332 - .../flyteidl/admin/version.proto.rst | 81 - .../flyteidl/admin/workflow.proto.rst | 174 - .../admin/workflow_attributes.proto.rst | 205 - .../flyteidl/core/catalog.proto.rst | 117 - .../flyteidl/core/compiler.proto.rst | 154 - .../flyteidl/core/condition.proto.rst | 206 - .../flyteidl/core/dynamic_job.proto.rst | 60 - .../flyteidl/core/errors.proto.rst | 92 - .../flyteidl/core/execution.proto.rst | 432 - .../flyteidl/core/identifier.proto.rst | 193 - .../gen/pb-protodoc/flyteidl/core/index.rst | 28 - .../flyteidl/core/interface.proto.rst | 154 - .../flyteidl/core/literals.proto.rst | 563 - .../flyteidl/core/security.proto.rst | 283 - .../pb-protodoc/flyteidl/core/tasks.proto.rst | 597 - .../pb-protodoc/flyteidl/core/types.proto.rst | 335 - .../flyteidl/core/workflow.proto.rst | 494 - .../flyteidl/core/workflow_closure.proto.rst | 35 - .../datacatalog/datacatalog.proto.rst | 1165 -- .../flyteidl/event/event.proto.rst | 593 - .../flyteidl/plugins/array_job.proto.rst | 62 - .../pb-protodoc/flyteidl/plugins/index.rst | 21 - .../flyteidl/plugins/presto.proto.rst | 45 - .../flyteidl/plugins/pytorch.proto.rst | 27 - .../flyteidl/plugins/qubole.proto.rst | 101 - .../hyperparameter_tuning_job.proto.rst | 230 - .../flyteidl/plugins/sagemaker/index.rst | 11 - .../sagemaker/parameter_ranges.proto.rst | 215 - .../plugins/sagemaker/training_job.proto.rst | 324 - .../flyteidl/plugins/sidecar.proto.rst | 34 - .../flyteidl/plugins/spark.proto.rst | 100 - .../flyteidl/plugins/tensorflow.proto.rst | 40 - .../flyteidl/plugins/waitable.proto.rst | 38 - .../flyteidl/service/admin.proto.rst | 5 - .../flyteidl/service/auth.proto.rst | 163 - .../flyteidl/service/identity.proto.rst | 85 - .../pb-protodoc/flyteidl/service/index.rst | 15 - .../google/api/annotations.proto.rst | 19 - .../gen/pb-protodoc/google/api/http.proto.rst | 496 - flyteidl/gen/pb-protodoc/google/api/index.rst | 10 - flyteidl/gen/pb-protodoc/google/index.rst | 10 - .../pb-protodoc/google/protobuf/any.proto.rst | 170 - .../google/protobuf/descriptor.proto.rst | 1816 --- .../google/protobuf/duration.proto.rst | 130 - .../gen/pb-protodoc/google/protobuf/index.rst | 13 - .../google/protobuf/struct.proto.rst | 194 - .../google/protobuf/timestamp.proto.rst | 150 - flyteidl/gen/pb-protodoc/index.rst | 12 - .../gen/pb-protodoc/k8s.io/api/core/index.rst | 9 - .../k8s.io/api/core/v1/generated.proto.rst | 10519 ---------------- .../pb-protodoc/k8s.io/api/core/v1/index.rst | 9 - flyteidl/gen/pb-protodoc/k8s.io/api/index.rst | 9 - .../pb-protodoc/k8s.io/apimachinery/index.rst | 9 - .../k8s.io/apimachinery/pkg/api/index.rst | 9 - .../pkg/api/resource/generated.proto.rst | 99 - .../apimachinery/pkg/api/resource/index.rst | 9 - .../k8s.io/apimachinery/pkg/apis/index.rst | 9 - .../apimachinery/pkg/apis/meta/index.rst | 9 - .../pkg/apis/meta/v1/generated.proto.rst | 1991 --- .../apimachinery/pkg/apis/meta/v1/index.rst | 9 - .../k8s.io/apimachinery/pkg/index.rst | 12 - .../pkg/runtime/generated.proto.rst | 188 - .../k8s.io/apimachinery/pkg/runtime/index.rst | 10 - .../pkg/runtime/schema/generated.proto.rst | 21 - .../apimachinery/pkg/runtime/schema/index.rst | 9 - .../k8s.io/apimachinery/pkg/util/index.rst | 9 - .../pkg/util/intstr/generated.proto.rst | 62 - .../apimachinery/pkg/util/intstr/index.rst | 9 - flyteidl/gen/pb-protodoc/k8s.io/index.rst | 10 - .../pb-protodoc/protoc-gen-swagger/index.rst | 9 - .../options/annotations.proto.rst | 5 - .../protoc-gen-swagger/options/index.rst | 10 - .../options/openapiv2.proto.rst | 1000 -- flyteidl/generate_protos.sh | 48 +- flyteidl/index.rst | 2 +- flyteidl/protos/docs/admin/admin.md | 2746 ++++ .../admin/title.rst => docs/admin/index.rst} | 10 +- flyteidl/protos/docs/core/core.md | 2155 ++++ .../core/title.rst => docs/core/index.rst} | 5 + .../protos/docs/datacatalog/datacatalog.md | 746 ++ .../docs}/datacatalog/index.rst | 11 +- flyteidl/protos/docs/event/event.md | 281 + .../flyteidl => protos/docs}/event/index.rst | 7 +- .../title.rst => docs/plugins/index.rst} | 6 + flyteidl/protos/docs/plugins/plugins.md | 420 + flyteidl/protos/docs/service/index.rst | 11 + flyteidl/protos/docs/service/service.md | 265 + .../protos/flyteidl/datacatalog/title.rst | 8 - flyteidl/protos/flyteidl/event/title.rst | 20 - flyteidl/protos/flyteidl/service/title.rst | 6 - flyteidl/protos/flyteidl/title.rst | 7 - .../pb-protodoc/flyteidl => protos}/index.rst | 13 +- 111 files changed, 6751 insertions(+), 28939 deletions(-) delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/admin/common.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/admin/event.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/admin/execution.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/admin/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/admin/launch_plan.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/admin/matchable_resource.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/admin/node_execution.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/admin/notification.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/admin/project.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/admin/project_domain_attributes.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/admin/schedule.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/admin/task.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/admin/task_execution.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/admin/version.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/admin/workflow.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/admin/workflow_attributes.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/core/catalog.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/core/compiler.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/core/condition.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/core/dynamic_job.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/core/errors.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/core/execution.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/core/identifier.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/core/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/core/interface.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/core/literals.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/core/security.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/core/tasks.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/core/types.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/core/workflow.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/core/workflow_closure.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/datacatalog/datacatalog.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/event/event.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/plugins/array_job.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/plugins/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/plugins/presto.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/plugins/pytorch.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/plugins/qubole.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/plugins/sagemaker/hyperparameter_tuning_job.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/plugins/sagemaker/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/plugins/sagemaker/parameter_ranges.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/plugins/sagemaker/training_job.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/plugins/sidecar.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/plugins/spark.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/plugins/tensorflow.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/plugins/waitable.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/service/admin.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/service/auth.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/service/identity.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/flyteidl/service/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/google/api/annotations.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/google/api/http.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/google/api/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/google/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/google/protobuf/any.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/google/protobuf/descriptor.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/google/protobuf/duration.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/google/protobuf/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/google/protobuf/struct.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/google/protobuf/timestamp.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/api/core/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/api/core/v1/generated.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/api/core/v1/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/api/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/apimachinery/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/api/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/api/resource/generated.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/api/resource/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/apis/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/apis/meta/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/apis/meta/v1/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/runtime/generated.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/runtime/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/runtime/schema/generated.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/runtime/schema/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/util/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/util/intstr/generated.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/util/intstr/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/k8s.io/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/protoc-gen-swagger/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/protoc-gen-swagger/options/annotations.proto.rst delete mode 100644 flyteidl/gen/pb-protodoc/protoc-gen-swagger/options/index.rst delete mode 100644 flyteidl/gen/pb-protodoc/protoc-gen-swagger/options/openapiv2.proto.rst create mode 100644 flyteidl/protos/docs/admin/admin.md rename flyteidl/protos/{flyteidl/admin/title.rst => docs/admin/index.rst} (54%) create mode 100644 flyteidl/protos/docs/core/core.md rename flyteidl/protos/{flyteidl/core/title.rst => docs/core/index.rst} (80%) create mode 100644 flyteidl/protos/docs/datacatalog/datacatalog.md rename flyteidl/{gen/pb-protodoc/flyteidl => protos/docs}/datacatalog/index.rst (79%) create mode 100644 flyteidl/protos/docs/event/event.md rename flyteidl/{gen/pb-protodoc/flyteidl => protos/docs}/event/index.rst (96%) rename flyteidl/protos/{flyteidl/plugins/title.rst => docs/plugins/index.rst} (66%) create mode 100644 flyteidl/protos/docs/plugins/plugins.md create mode 100644 flyteidl/protos/docs/service/index.rst create mode 100644 flyteidl/protos/docs/service/service.md delete mode 100644 flyteidl/protos/flyteidl/datacatalog/title.rst delete mode 100644 flyteidl/protos/flyteidl/event/title.rst delete mode 100644 flyteidl/protos/flyteidl/service/title.rst delete mode 100644 flyteidl/protos/flyteidl/title.rst rename flyteidl/{gen/pb-protodoc/flyteidl => protos}/index.rst (74%) diff --git a/flyteidl/.github/workflows/verification.yml b/flyteidl/.github/workflows/verification.yml index fa5fdc66eb..acd164ebf4 100644 --- a/flyteidl/.github/workflows/verification.yml +++ b/flyteidl/.github/workflows/verification.yml @@ -101,20 +101,6 @@ jobs: - name: Proto-Datacatalog-Java run: python3 /usr/local/bin/entrypoint.py -i ./protos -d protos/flyteidl/datacatalog -l java - # Docs - - name: Docs-Service - run: python3 /usr/local/bin/entrypoint.py -i ./protos -d protos/flyteidl/service -l protodoc - - name: Docs-Admin - run: python3 /usr/local/bin/entrypoint.py -i ./protos -d protos/flyteidl/admin -l protodoc - - name: Docs-Core - run: python3 /usr/local/bin/entrypoint.py -i ./protos -d protos/flyteidl/core -l protodoc - - name: Docs-Event - run: python3 /usr/local/bin/entrypoint.py -i ./protos -d protos/flyteidl/event -l protodoc - - name: Docs-Plugins - run: python3 /usr/local/bin/entrypoint.py -i ./protos -d protos/flyteidl/plugins -l protodoc - - name: Docs-Datacatalog - run: python3 /usr/local/bin/entrypoint.py -i ./protos -d protos/flyteidl/datacatalog -l protodoc - - uses: actions/upload-artifact@master with: name: generated diff --git a/flyteidl/.gitignore b/flyteidl/.gitignore index 178bb33f4c..41e4661d5e 100644 --- a/flyteidl/.gitignore +++ b/flyteidl/.gitignore @@ -12,4 +12,5 @@ gen/pb_python/flyteidl.egg-info/ .virtualgo docs/build/ -.vscode/ \ No newline at end of file +.vscode/ +tmp/ diff --git a/flyteidl/Makefile b/flyteidl/Makefile index 92a4cdf9be..10a519031a 100644 --- a/flyteidl/Makefile +++ b/flyteidl/Makefile @@ -12,7 +12,7 @@ update_boilerplate: @boilerplate/update.sh .PHONY: generate -generate: install # install tools, generate protos, mocks and pflags +generate: install doc_gen_deps # install tools, generate protos, doc dependecies, mocks and pflags ./generate_protos.sh ./generate_mocks.sh go generate ./... @@ -38,6 +38,23 @@ build_python: install-piptools: pip install -U pip-tools +.PHONY: doc_gen_deps # these dependencies are required by protoc gen doc for the protos which have external library dependencies. +# which includes grpc-gateway, googleapis, k8.io/api and apimachinery, protocolbuffers +doc_gen_deps: + rm -rf tmp/doc_gen_deps tmp/protocolbuffers tmp/grpc-gateway tmp/k8s.io + git clone --depth 1 https://github.com/googleapis/googleapis tmp/doc_gen_deps + rm -rf tmp/doc_gen_deps/.git + git clone --depth 1 https://github.com/protocolbuffers/protobuf tmp/protocolbuffers + cp -r tmp/protocolbuffers/src/* tmp/doc_gen_deps/ + rm -rf tmp/protocolbuffers + git -c advice.detachedHead=false clone --depth 1 --branch v1.15.2 https://github.com/grpc-ecosystem/grpc-gateway tmp/grpc-gateway #v1.15.2 is used to keep the grpc-gateway version in sync with generated protos which is using the LYFT image + cp -r tmp/grpc-gateway/protoc-gen-swagger tmp/doc_gen_deps/ + rm -rf tmp/grpc-gateway + git clone --depth 1 https://github.com/kubernetes/api tmp/k8s.io/api + git clone --depth 1 https://github.com/kubernetes/apimachinery tmp/k8s.io/apimachinery + cp -r tmp/k8s.io tmp/doc_gen_deps/ + rm -rf tmp/k8s.io + .PHONY: doc-requirements.txt doc-requirements.txt: doc-requirements.in install-piptools $(call PIP_COMPILE,doc-requirements.in) @@ -53,4 +70,4 @@ update_pyversion: .PHONY: update_npmversion update_npmversion: grep "$(PLACEHOLDER_NPM)" "package.json" - sed -i "s/$(PLACEHOLDER_NPM)/\"version\": \"${VERSION}\"/g" "package.json" \ No newline at end of file + sed -i "s/$(PLACEHOLDER_NPM)/\"version\": \"${VERSION}\"/g" "package.json" diff --git a/flyteidl/conf.py b/flyteidl/conf.py index 7671d861e5..d2edb7ddc7 100644 --- a/flyteidl/conf.py +++ b/flyteidl/conf.py @@ -17,6 +17,8 @@ import sys sys.path.insert(0, os.path.abspath("gen/pb-protodoc/")) +import recommonmark +from recommonmark.transform import AutoStructify # -- Project information ----------------------------------------------------- @@ -48,6 +50,8 @@ "sphinx-prompt", "sphinx_copybutton", "sphinx_search.extension", + "recommonmark", + "sphinx_markdown_tables", ] # build the templated autosummary files @@ -64,8 +68,7 @@ # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # -# source_suffix = ['.rst', '.md'] -source_suffix = ".rst" +source_suffix = ['.rst', '.md'] # The master toctree document. master_doc = "index" @@ -80,7 +83,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path . -exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store', 'tmp/doc_gen_deps', 'gen/*/*/*/*/*', 'boilerplate', 'pull_request_template.md', 'README.rst', 'reference/*', 'CODE_OF_CONDUCT.md'] # The name of the Pygments (syntax highlighting) style to use. pygments_style = "tango" @@ -189,3 +192,12 @@ intersphinx_mapping = { "python": ("https://docs.python.org/{.major}".format(sys.version_info), None), } + +def setup(app): + app.add_config_value('recommonmark_config', { + 'auto_toc_tree_section': 'Contents', + 'enable_math': False, + 'enable_inline_math': False, + 'enable_eval_rst': True, + }, True) + app.add_transform(AutoStructify) diff --git a/flyteidl/doc-requirements.in b/flyteidl/doc-requirements.in index 3cf9da6f2f..11d0a935e1 100644 --- a/flyteidl/doc-requirements.in +++ b/flyteidl/doc-requirements.in @@ -1,7 +1,9 @@ git+git://github.com/flyteorg/furo@main readthedocs-sphinx-search +recommonmark sphinx sphinx-prompt sphinx-material sphinx-code-include sphinx-copybutton +sphinx_markdown_tables diff --git a/flyteidl/doc-requirements.txt b/flyteidl/doc-requirements.txt index 8df6e8b686..7704caff39 100644 --- a/flyteidl/doc-requirements.txt +++ b/flyteidl/doc-requirements.txt @@ -17,10 +17,14 @@ certifi==2020.12.5 # via requests chardet==4.0.0 # via requests +commonmark==0.9.1 + # via recommonmark css-html-js-minify==2.5.5 # via sphinx-material docutils==0.16 - # via sphinx + # via + # recommonmark + # sphinx git+git://github.com/flyteorg/furo@main # via -r doc-requirements.in idna==2.10 @@ -31,6 +35,8 @@ jinja2==2.11.3 # via sphinx lxml==4.6.3 # via sphinx-material +markdown==3.3.4 + # via sphinx-markdown-tables markupsafe==1.1.1 # via jinja2 packaging==20.9 @@ -47,6 +53,8 @@ pytz==2021.1 # via babel readthedocs-sphinx-search==0.1.0 # via -r doc-requirements.in +recommonmark==0.7.1 + # via -r doc-requirements.in requests==2.25.1 # via sphinx six==1.15.0 @@ -59,6 +67,8 @@ sphinx-code-include==1.1.1 # via -r doc-requirements.in sphinx-copybutton==0.3.1 # via -r doc-requirements.in +sphinx-markdown-tables==0.0.15 + # via -r doc-requirements.in sphinx-material==0.0.32 # via -r doc-requirements.in sphinx-prompt==1.4.0 @@ -67,6 +77,7 @@ sphinx==3.5.4 # via # -r doc-requirements.in # furo + # recommonmark # sphinx-code-include # sphinx-copybutton # sphinx-material diff --git a/flyteidl/gen/pb-protodoc/flyteidl/admin/common.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/admin/common.proto.rst deleted file mode 100644 index 45db7ba8e0..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/admin/common.proto.rst +++ /dev/null @@ -1,800 +0,0 @@ -.. _api_file_flyteidl/admin/common.proto: - -common.proto -=========================== - -.. _api_msg_flyteidl.admin.NamedEntityIdentifier: - -flyteidl.admin.NamedEntityIdentifier ------------------------------------- - -`[flyteidl.admin.NamedEntityIdentifier proto] `_ - -Encapsulation of fields that identifies a Flyte resource. -A resource can internally have multiple versions. - -.. code-block:: json - - { - "project": "...", - "domain": "...", - "name": "..." - } - -.. _api_field_flyteidl.admin.NamedEntityIdentifier.project: - -project - (`string `_) Name of the project the resource belongs to. - - -.. _api_field_flyteidl.admin.NamedEntityIdentifier.domain: - -domain - (`string `_) Name of the domain the resource belongs to. - A domain can be considered as a subset within a specific project. - - -.. _api_field_flyteidl.admin.NamedEntityIdentifier.name: - -name - (`string `_) User provided value for the resource. - The combination of project + domain + name uniquely identifies the resource. - +optional - in certain contexts - like 'List API', 'Launch plans' - - - - -.. _api_msg_flyteidl.admin.NamedEntityMetadata: - -flyteidl.admin.NamedEntityMetadata ----------------------------------- - -`[flyteidl.admin.NamedEntityMetadata proto] `_ - - -.. code-block:: json - - { - "description": "...", - "state": "..." - } - -.. _api_field_flyteidl.admin.NamedEntityMetadata.description: - -description - (`string `_) Common description across all versions of the entity - +optional - - -.. _api_field_flyteidl.admin.NamedEntityMetadata.state: - -state - (:ref:`flyteidl.admin.NamedEntityState `) Shared state across all version of the entity - At this point in time, only workflow entities can have their state archived. - - - - -.. _api_msg_flyteidl.admin.NamedEntity: - -flyteidl.admin.NamedEntity --------------------------- - -`[flyteidl.admin.NamedEntity proto] `_ - -Describes information common to a NamedEntity, identified by a project / -domain / name / resource type combination - -.. code-block:: json - - { - "resource_type": "...", - "id": "{...}", - "metadata": "{...}" - } - -.. _api_field_flyteidl.admin.NamedEntity.resource_type: - -resource_type - (:ref:`flyteidl.core.ResourceType `) - -.. _api_field_flyteidl.admin.NamedEntity.id: - -id - (:ref:`flyteidl.admin.NamedEntityIdentifier `) - -.. _api_field_flyteidl.admin.NamedEntity.metadata: - -metadata - (:ref:`flyteidl.admin.NamedEntityMetadata `) - - - -.. _api_msg_flyteidl.admin.Sort: - -flyteidl.admin.Sort -------------------- - -`[flyteidl.admin.Sort proto] `_ - -Species sort ordering in a list request. - -.. code-block:: json - - { - "key": "...", - "direction": "..." - } - -.. _api_field_flyteidl.admin.Sort.key: - -key - (`string `_) Indicates an attribute to sort the response values. - TODO(katrogan): Add string validation here. This should never be empty. - - -.. _api_field_flyteidl.admin.Sort.direction: - -direction - (:ref:`flyteidl.admin.Sort.Direction `) Indicates the direction to apply sort key for response values. - +optional - - - -.. _api_enum_flyteidl.admin.Sort.Direction: - -Enum flyteidl.admin.Sort.Direction ----------------------------------- - -`[flyteidl.admin.Sort.Direction proto] `_ - - -.. _api_enum_value_flyteidl.admin.Sort.Direction.DESCENDING: - -DESCENDING - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.admin.Sort.Direction.ASCENDING: - -ASCENDING - ⁣ - - -.. _api_msg_flyteidl.admin.NamedEntityIdentifierListRequest: - -flyteidl.admin.NamedEntityIdentifierListRequest ------------------------------------------------ - -`[flyteidl.admin.NamedEntityIdentifierListRequest proto] `_ - -Represents a request structure to list identifiers. - -.. code-block:: json - - { - "project": "...", - "domain": "...", - "limit": "...", - "token": "...", - "sort_by": "{...}", - "filters": "..." - } - -.. _api_field_flyteidl.admin.NamedEntityIdentifierListRequest.project: - -project - (`string `_) Name of the project that contains the identifiers. - - -.. _api_field_flyteidl.admin.NamedEntityIdentifierListRequest.domain: - -domain - (`string `_) Name of the domain the identifiers belongs to within the project. - - -.. _api_field_flyteidl.admin.NamedEntityIdentifierListRequest.limit: - -limit - (`uint32 `_) Indicates the number of resources to be returned. - - -.. _api_field_flyteidl.admin.NamedEntityIdentifierListRequest.token: - -token - (`string `_) In the case of multiple pages of results, the server-provided token can be used to fetch the next page - in a query. - +optional - - -.. _api_field_flyteidl.admin.NamedEntityIdentifierListRequest.sort_by: - -sort_by - (:ref:`flyteidl.admin.Sort `) Sort ordering. - +optional - - -.. _api_field_flyteidl.admin.NamedEntityIdentifierListRequest.filters: - -filters - (`string `_) Indicates a list of filters passed as string. - +optional - - - - -.. _api_msg_flyteidl.admin.NamedEntityListRequest: - -flyteidl.admin.NamedEntityListRequest -------------------------------------- - -`[flyteidl.admin.NamedEntityListRequest proto] `_ - -Represents a request structure to list NamedEntity objects - -.. code-block:: json - - { - "resource_type": "...", - "project": "...", - "domain": "...", - "limit": "...", - "token": "...", - "sort_by": "{...}", - "filters": "..." - } - -.. _api_field_flyteidl.admin.NamedEntityListRequest.resource_type: - -resource_type - (:ref:`flyteidl.core.ResourceType `) - -.. _api_field_flyteidl.admin.NamedEntityListRequest.project: - -project - (`string `_) Name of the project that contains the identifiers. - - -.. _api_field_flyteidl.admin.NamedEntityListRequest.domain: - -domain - (`string `_) Name of the domain the identifiers belongs to within the project. - - -.. _api_field_flyteidl.admin.NamedEntityListRequest.limit: - -limit - (`uint32 `_) Indicates the number of resources to be returned. - - -.. _api_field_flyteidl.admin.NamedEntityListRequest.token: - -token - (`string `_) In the case of multiple pages of results, the server-provided token can be used to fetch the next page - in a query. - +optional - - -.. _api_field_flyteidl.admin.NamedEntityListRequest.sort_by: - -sort_by - (:ref:`flyteidl.admin.Sort `) Sort ordering. - +optional - - -.. _api_field_flyteidl.admin.NamedEntityListRequest.filters: - -filters - (`string `_) Indicates a list of filters passed as string. - +optional - - - - -.. _api_msg_flyteidl.admin.NamedEntityIdentifierList: - -flyteidl.admin.NamedEntityIdentifierList ----------------------------------------- - -`[flyteidl.admin.NamedEntityIdentifierList proto] `_ - -Represents a list of NamedEntityIdentifiers. - -.. code-block:: json - - { - "entities": [], - "token": "..." - } - -.. _api_field_flyteidl.admin.NamedEntityIdentifierList.entities: - -entities - (:ref:`flyteidl.admin.NamedEntityIdentifier `) A list of identifiers. - - -.. _api_field_flyteidl.admin.NamedEntityIdentifierList.token: - -token - (`string `_) In the case of multiple pages of results, the server-provided token can be used to fetch the next page - in a query. If there are no more results, this value will be empty. - - - - -.. _api_msg_flyteidl.admin.NamedEntityList: - -flyteidl.admin.NamedEntityList ------------------------------- - -`[flyteidl.admin.NamedEntityList proto] `_ - -Represents a list of NamedEntityIdentifiers. - -.. code-block:: json - - { - "entities": [], - "token": "..." - } - -.. _api_field_flyteidl.admin.NamedEntityList.entities: - -entities - (:ref:`flyteidl.admin.NamedEntity `) A list of NamedEntity objects - - -.. _api_field_flyteidl.admin.NamedEntityList.token: - -token - (`string `_) In the case of multiple pages of results, the server-provided token can be used to fetch the next page - in a query. If there are no more results, this value will be empty. - - - - -.. _api_msg_flyteidl.admin.NamedEntityGetRequest: - -flyteidl.admin.NamedEntityGetRequest ------------------------------------- - -`[flyteidl.admin.NamedEntityGetRequest proto] `_ - -A request to retrieve the metadata associated with a NamedEntityIdentifier - -.. code-block:: json - - { - "resource_type": "...", - "id": "{...}" - } - -.. _api_field_flyteidl.admin.NamedEntityGetRequest.resource_type: - -resource_type - (:ref:`flyteidl.core.ResourceType `) - -.. _api_field_flyteidl.admin.NamedEntityGetRequest.id: - -id - (:ref:`flyteidl.admin.NamedEntityIdentifier `) - - - -.. _api_msg_flyteidl.admin.NamedEntityUpdateRequest: - -flyteidl.admin.NamedEntityUpdateRequest ---------------------------------------- - -`[flyteidl.admin.NamedEntityUpdateRequest proto] `_ - -Request to set the referenced launch plan state to the configured value. - -.. code-block:: json - - { - "resource_type": "...", - "id": "{...}", - "metadata": "{...}" - } - -.. _api_field_flyteidl.admin.NamedEntityUpdateRequest.resource_type: - -resource_type - (:ref:`flyteidl.core.ResourceType `) Resource type of the metadata to update - - -.. _api_field_flyteidl.admin.NamedEntityUpdateRequest.id: - -id - (:ref:`flyteidl.admin.NamedEntityIdentifier `) Identifier of the metadata to update - - -.. _api_field_flyteidl.admin.NamedEntityUpdateRequest.metadata: - -metadata - (:ref:`flyteidl.admin.NamedEntityMetadata `) Metadata object to set as the new value - - - - -.. _api_msg_flyteidl.admin.NamedEntityUpdateResponse: - -flyteidl.admin.NamedEntityUpdateResponse ----------------------------------------- - -`[flyteidl.admin.NamedEntityUpdateResponse proto] `_ - -Purposefully empty, may be populated in the future. - -.. code-block:: json - - {} - - - - -.. _api_msg_flyteidl.admin.ObjectGetRequest: - -flyteidl.admin.ObjectGetRequest -------------------------------- - -`[flyteidl.admin.ObjectGetRequest proto] `_ - -Represents a structure to fetch a single resource. - -.. code-block:: json - - { - "id": "{...}" - } - -.. _api_field_flyteidl.admin.ObjectGetRequest.id: - -id - (:ref:`flyteidl.core.Identifier `) Indicates a unique version of resource. - - - - -.. _api_msg_flyteidl.admin.ResourceListRequest: - -flyteidl.admin.ResourceListRequest ----------------------------------- - -`[flyteidl.admin.ResourceListRequest proto] `_ - -Represents a request structure to retrieve a list of resources. -Resources include: Task, Workflow, LaunchPlan - -.. code-block:: json - - { - "id": "{...}", - "limit": "...", - "token": "...", - "filters": "...", - "sort_by": "{...}" - } - -.. _api_field_flyteidl.admin.ResourceListRequest.id: - -id - (:ref:`flyteidl.admin.NamedEntityIdentifier `) id represents the unique identifier of the resource. - - -.. _api_field_flyteidl.admin.ResourceListRequest.limit: - -limit - (`uint32 `_) Indicates the number of resources to be returned. - - -.. _api_field_flyteidl.admin.ResourceListRequest.token: - -token - (`string `_) In the case of multiple pages of results, this server-provided token can be used to fetch the next page - in a query. - +optional - - -.. _api_field_flyteidl.admin.ResourceListRequest.filters: - -filters - (`string `_) Indicates a list of filters passed as string. - More info on constructing filters : - +optional - - -.. _api_field_flyteidl.admin.ResourceListRequest.sort_by: - -sort_by - (:ref:`flyteidl.admin.Sort `) Sort ordering. - +optional - - - - -.. _api_msg_flyteidl.admin.EmailNotification: - -flyteidl.admin.EmailNotification --------------------------------- - -`[flyteidl.admin.EmailNotification proto] `_ - - -.. code-block:: json - - { - "recipients_email": [] - } - -.. _api_field_flyteidl.admin.EmailNotification.recipients_email: - -recipients_email - (`string `_) The list of email addresses recipients for this notification. - - - - -.. _api_msg_flyteidl.admin.PagerDutyNotification: - -flyteidl.admin.PagerDutyNotification ------------------------------------- - -`[flyteidl.admin.PagerDutyNotification proto] `_ - - -.. code-block:: json - - { - "recipients_email": [] - } - -.. _api_field_flyteidl.admin.PagerDutyNotification.recipients_email: - -recipients_email - (`string `_) Currently, PagerDuty notifications leverage email to trigger a notification. - - - - -.. _api_msg_flyteidl.admin.SlackNotification: - -flyteidl.admin.SlackNotification --------------------------------- - -`[flyteidl.admin.SlackNotification proto] `_ - - -.. code-block:: json - - { - "recipients_email": [] - } - -.. _api_field_flyteidl.admin.SlackNotification.recipients_email: - -recipients_email - (`string `_) Currently, Slack notifications leverage email to trigger a notification. - - - - -.. _api_msg_flyteidl.admin.Notification: - -flyteidl.admin.Notification ---------------------------- - -`[flyteidl.admin.Notification proto] `_ - -Represents a structure for notifications based on execution status. -The Notification content is configured within Admin. Future iterations could -expose configuring notifications with custom content. - -.. code-block:: json - - { - "phases": [], - "email": "{...}", - "pager_duty": "{...}", - "slack": "{...}" - } - -.. _api_field_flyteidl.admin.Notification.phases: - -phases - (:ref:`flyteidl.core.WorkflowExecution.Phase `) A list of phases to which users can associate the notifications to. - - -.. _api_field_flyteidl.admin.Notification.email: - -email - (:ref:`flyteidl.admin.EmailNotification `) option (validate.required) = true; - - - - Only one of :ref:`email `, :ref:`pager_duty `, :ref:`slack ` may be set. - -.. _api_field_flyteidl.admin.Notification.pager_duty: - -pager_duty - (:ref:`flyteidl.admin.PagerDutyNotification `) - - - Only one of :ref:`email `, :ref:`pager_duty `, :ref:`slack ` may be set. - -.. _api_field_flyteidl.admin.Notification.slack: - -slack - (:ref:`flyteidl.admin.SlackNotification `) - - - Only one of :ref:`email `, :ref:`pager_duty `, :ref:`slack ` may be set. - - - -.. _api_msg_flyteidl.admin.UrlBlob: - -flyteidl.admin.UrlBlob ----------------------- - -`[flyteidl.admin.UrlBlob proto] `_ - -Represents a string url and associated metadata used throughout the platform. - -.. code-block:: json - - { - "url": "...", - "bytes": "..." - } - -.. _api_field_flyteidl.admin.UrlBlob.url: - -url - (`string `_) Actual url value. - - -.. _api_field_flyteidl.admin.UrlBlob.bytes: - -bytes - (`int64 `_) Represents the size of the file accessible at the above url. - - - - -.. _api_msg_flyteidl.admin.Labels: - -flyteidl.admin.Labels ---------------------- - -`[flyteidl.admin.Labels proto] `_ - -Label values to be applied to an execution resource. -In the future a mode (e.g. OVERRIDE, APPEND, etc) can be defined -to specify how to merge labels defined at registration and execution time. - -.. code-block:: json - - { - "values": "{...}" - } - -.. _api_field_flyteidl.admin.Labels.values: - -values - (map<`string `_, `string `_>) Map of custom labels to be applied to the execution resource. - - - - -.. _api_msg_flyteidl.admin.Annotations: - -flyteidl.admin.Annotations --------------------------- - -`[flyteidl.admin.Annotations proto] `_ - -Annotation values to be applied to an execution resource. -In the future a mode (e.g. OVERRIDE, APPEND, etc) can be defined -to specify how to merge annotations defined at registration and execution time. - -.. code-block:: json - - { - "values": "{...}" - } - -.. _api_field_flyteidl.admin.Annotations.values: - -values - (map<`string `_, `string `_>) Map of custom annotations to be applied to the execution resource. - - - - -.. _api_msg_flyteidl.admin.AuthRole: - -flyteidl.admin.AuthRole ------------------------ - -`[flyteidl.admin.AuthRole proto] `_ - -Defines permissions associated with executions. -Deprecated, please use core.SecurityContext - -.. code-block:: json - - { - "assumable_iam_role": "...", - "kubernetes_service_account": "..." - } - -.. _api_field_flyteidl.admin.AuthRole.assumable_iam_role: - -assumable_iam_role - (`string `_) - - - Only one of :ref:`assumable_iam_role `, :ref:`kubernetes_service_account ` may be set. - -.. _api_field_flyteidl.admin.AuthRole.kubernetes_service_account: - -kubernetes_service_account - (`string `_) - - - Only one of :ref:`assumable_iam_role `, :ref:`kubernetes_service_account ` may be set. - - - -.. _api_msg_flyteidl.admin.RawOutputDataConfig: - -flyteidl.admin.RawOutputDataConfig ----------------------------------- - -`[flyteidl.admin.RawOutputDataConfig proto] `_ - -Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.). -See https://github.com/flyteorg/flyte/issues/211 for more background information. - -.. code-block:: json - - { - "output_location_prefix": "..." - } - -.. _api_field_flyteidl.admin.RawOutputDataConfig.output_location_prefix: - -output_location_prefix - (`string `_) Prefix for where offloaded data from user workflows will be written - e.g. s3://bucket/key or s3://bucket/ - - - -.. _api_enum_flyteidl.admin.NamedEntityState: - -Enum flyteidl.admin.NamedEntityState ------------------------------------- - -`[flyteidl.admin.NamedEntityState proto] `_ - -The status of the named entity is used to control its visibility in the UI. - -.. _api_enum_value_flyteidl.admin.NamedEntityState.NAMED_ENTITY_ACTIVE: - -NAMED_ENTITY_ACTIVE - *(DEFAULT)* ⁣By default, all named entities are considered active and under development. - - -.. _api_enum_value_flyteidl.admin.NamedEntityState.NAMED_ENTITY_ARCHIVED: - -NAMED_ENTITY_ARCHIVED - ⁣Archived named entities are no longer visible in the UI. - - -.. _api_enum_value_flyteidl.admin.NamedEntityState.SYSTEM_GENERATED: - -SYSTEM_GENERATED - ⁣System generated entities that aren't explicitly created or managed by a user. - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/admin/event.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/admin/event.proto.rst deleted file mode 100644 index ab2b2125f3..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/admin/event.proto.rst +++ /dev/null @@ -1,182 +0,0 @@ -.. _api_file_flyteidl/admin/event.proto: - -event.proto -========================== - -.. _api_msg_flyteidl.admin.EventErrorAlreadyInTerminalState: - -flyteidl.admin.EventErrorAlreadyInTerminalState ------------------------------------------------ - -`[flyteidl.admin.EventErrorAlreadyInTerminalState proto] `_ - - -.. code-block:: json - - { - "current_phase": "..." - } - -.. _api_field_flyteidl.admin.EventErrorAlreadyInTerminalState.current_phase: - -current_phase - (`string `_) - - - -.. _api_msg_flyteidl.admin.EventFailureReason: - -flyteidl.admin.EventFailureReason ---------------------------------- - -`[flyteidl.admin.EventFailureReason proto] `_ - - -.. code-block:: json - - { - "already_in_terminal_state": "{...}" - } - -.. _api_field_flyteidl.admin.EventFailureReason.already_in_terminal_state: - -already_in_terminal_state - (:ref:`flyteidl.admin.EventErrorAlreadyInTerminalState `) - - - - -.. _api_msg_flyteidl.admin.WorkflowExecutionEventRequest: - -flyteidl.admin.WorkflowExecutionEventRequest --------------------------------------------- - -`[flyteidl.admin.WorkflowExecutionEventRequest proto] `_ - -Request to send a notification that a workflow execution event has occurred. - -.. code-block:: json - - { - "request_id": "...", - "event": "{...}" - } - -.. _api_field_flyteidl.admin.WorkflowExecutionEventRequest.request_id: - -request_id - (`string `_) Unique ID for this request that can be traced between services - - -.. _api_field_flyteidl.admin.WorkflowExecutionEventRequest.event: - -event - (:ref:`flyteidl.event.WorkflowExecutionEvent `) Details about the event that occurred. - - - - -.. _api_msg_flyteidl.admin.WorkflowExecutionEventResponse: - -flyteidl.admin.WorkflowExecutionEventResponse ---------------------------------------------- - -`[flyteidl.admin.WorkflowExecutionEventResponse proto] `_ - - -.. code-block:: json - - {} - - - - -.. _api_msg_flyteidl.admin.NodeExecutionEventRequest: - -flyteidl.admin.NodeExecutionEventRequest ----------------------------------------- - -`[flyteidl.admin.NodeExecutionEventRequest proto] `_ - -Request to send a notification that a node execution event has occurred. - -.. code-block:: json - - { - "request_id": "...", - "event": "{...}" - } - -.. _api_field_flyteidl.admin.NodeExecutionEventRequest.request_id: - -request_id - (`string `_) Unique ID for this request that can be traced between services - - -.. _api_field_flyteidl.admin.NodeExecutionEventRequest.event: - -event - (:ref:`flyteidl.event.NodeExecutionEvent `) Details about the event that occurred. - - - - -.. _api_msg_flyteidl.admin.NodeExecutionEventResponse: - -flyteidl.admin.NodeExecutionEventResponse ------------------------------------------ - -`[flyteidl.admin.NodeExecutionEventResponse proto] `_ - - -.. code-block:: json - - {} - - - - -.. _api_msg_flyteidl.admin.TaskExecutionEventRequest: - -flyteidl.admin.TaskExecutionEventRequest ----------------------------------------- - -`[flyteidl.admin.TaskExecutionEventRequest proto] `_ - -Request to send a notification that a task execution event has occurred. - -.. code-block:: json - - { - "request_id": "...", - "event": "{...}" - } - -.. _api_field_flyteidl.admin.TaskExecutionEventRequest.request_id: - -request_id - (`string `_) Unique ID for this request that can be traced between services - - -.. _api_field_flyteidl.admin.TaskExecutionEventRequest.event: - -event - (:ref:`flyteidl.event.TaskExecutionEvent `) Details about the event that occurred. - - - - -.. _api_msg_flyteidl.admin.TaskExecutionEventResponse: - -flyteidl.admin.TaskExecutionEventResponse ------------------------------------------ - -`[flyteidl.admin.TaskExecutionEventResponse proto] `_ - - -.. code-block:: json - - {} - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/admin/execution.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/admin/execution.proto.rst deleted file mode 100644 index 50190d0464..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/admin/execution.proto.rst +++ /dev/null @@ -1,761 +0,0 @@ -.. _api_file_flyteidl/admin/execution.proto: - -execution.proto -============================== - -.. _api_msg_flyteidl.admin.ExecutionCreateRequest: - -flyteidl.admin.ExecutionCreateRequest -------------------------------------- - -`[flyteidl.admin.ExecutionCreateRequest proto] `_ - -Request to launch an execution with the given project, domain and optionally name. - -.. code-block:: json - - { - "project": "...", - "domain": "...", - "name": "...", - "spec": "{...}", - "inputs": "{...}" - } - -.. _api_field_flyteidl.admin.ExecutionCreateRequest.project: - -project - (`string `_) Name of the project the execution belongs to. - - -.. _api_field_flyteidl.admin.ExecutionCreateRequest.domain: - -domain - (`string `_) Name of the domain the execution belongs to. - A domain can be considered as a subset within a specific project. - - -.. _api_field_flyteidl.admin.ExecutionCreateRequest.name: - -name - (`string `_) User provided value for the resource. - If none is provided the system will generate a unique string. - +optional - - -.. _api_field_flyteidl.admin.ExecutionCreateRequest.spec: - -spec - (:ref:`flyteidl.admin.ExecutionSpec `) Additional fields necessary to launch the execution. - - -.. _api_field_flyteidl.admin.ExecutionCreateRequest.inputs: - -inputs - (:ref:`flyteidl.core.LiteralMap `) The inputs required to start the execution. All required inputs must be - included in this map. If not required and not provided, defaults apply. - - - - -.. _api_msg_flyteidl.admin.ExecutionRelaunchRequest: - -flyteidl.admin.ExecutionRelaunchRequest ---------------------------------------- - -`[flyteidl.admin.ExecutionRelaunchRequest proto] `_ - -Request to relaunch the referenced execution. - -.. code-block:: json - - { - "id": "{...}", - "name": "..." - } - -.. _api_field_flyteidl.admin.ExecutionRelaunchRequest.id: - -id - (:ref:`flyteidl.core.WorkflowExecutionIdentifier `) Identifier of the workflow execution to relaunch. - - -.. _api_field_flyteidl.admin.ExecutionRelaunchRequest.name: - -name - (`string `_) User provided value for the relaunched execution. - If none is provided the system will generate a unique string. - +optional - - - - -.. _api_msg_flyteidl.admin.ExecutionCreateResponse: - -flyteidl.admin.ExecutionCreateResponse --------------------------------------- - -`[flyteidl.admin.ExecutionCreateResponse proto] `_ - -The unique identifier for a successfully created execution. -If the name was *not* specified in the create request, this identifier will include a generated name. - -.. code-block:: json - - { - "id": "{...}" - } - -.. _api_field_flyteidl.admin.ExecutionCreateResponse.id: - -id - (:ref:`flyteidl.core.WorkflowExecutionIdentifier `) - - - -.. _api_msg_flyteidl.admin.WorkflowExecutionGetRequest: - -flyteidl.admin.WorkflowExecutionGetRequest ------------------------------------------- - -`[flyteidl.admin.WorkflowExecutionGetRequest proto] `_ - -A message used to fetch a single workflow execution entity. - -.. code-block:: json - - { - "id": "{...}" - } - -.. _api_field_flyteidl.admin.WorkflowExecutionGetRequest.id: - -id - (:ref:`flyteidl.core.WorkflowExecutionIdentifier `) Uniquely identifies an individual workflow execution. - - - - -.. _api_msg_flyteidl.admin.Execution: - -flyteidl.admin.Execution ------------------------- - -`[flyteidl.admin.Execution proto] `_ - -A workflow execution represents an instantiated workflow, including all inputs and additional -metadata as well as computed results included state, outputs, and duration-based attributes. -Used as a response object used in Get and List execution requests. - -.. code-block:: json - - { - "id": "{...}", - "spec": "{...}", - "closure": "{...}" - } - -.. _api_field_flyteidl.admin.Execution.id: - -id - (:ref:`flyteidl.core.WorkflowExecutionIdentifier `) Unique identifier of the workflow execution. - - -.. _api_field_flyteidl.admin.Execution.spec: - -spec - (:ref:`flyteidl.admin.ExecutionSpec `) User-provided configuration and inputs for launching the execution. - - -.. _api_field_flyteidl.admin.Execution.closure: - -closure - (:ref:`flyteidl.admin.ExecutionClosure `) Execution results. - - - - -.. _api_msg_flyteidl.admin.ExecutionList: - -flyteidl.admin.ExecutionList ----------------------------- - -`[flyteidl.admin.ExecutionList proto] `_ - -Used as a response for request to list executions. - -.. code-block:: json - - { - "executions": [], - "token": "..." - } - -.. _api_field_flyteidl.admin.ExecutionList.executions: - -executions - (:ref:`flyteidl.admin.Execution `) - -.. _api_field_flyteidl.admin.ExecutionList.token: - -token - (`string `_) In the case of multiple pages of results, the server-provided token can be used to fetch the next page - in a query. If there are no more results, this value will be empty. - - - - -.. _api_msg_flyteidl.admin.LiteralMapBlob: - -flyteidl.admin.LiteralMapBlob ------------------------------ - -`[flyteidl.admin.LiteralMapBlob proto] `_ - -Input/output data can represented by actual values or a link to where values are stored - -.. code-block:: json - - { - "values": "{...}", - "uri": "..." - } - -.. _api_field_flyteidl.admin.LiteralMapBlob.values: - -values - (:ref:`flyteidl.core.LiteralMap `) Data in LiteralMap format - - - - Only one of :ref:`values `, :ref:`uri ` may be set. - -.. _api_field_flyteidl.admin.LiteralMapBlob.uri: - -uri - (`string `_) In the event that the map is too large, we return a uri to the data - - - - Only one of :ref:`values `, :ref:`uri ` may be set. - - - -.. _api_msg_flyteidl.admin.AbortMetadata: - -flyteidl.admin.AbortMetadata ----------------------------- - -`[flyteidl.admin.AbortMetadata proto] `_ - - -.. code-block:: json - - { - "cause": "...", - "principal": "..." - } - -.. _api_field_flyteidl.admin.AbortMetadata.cause: - -cause - (`string `_) In the case of a user-specified abort, this will pass along the user-supplied cause. - - -.. _api_field_flyteidl.admin.AbortMetadata.principal: - -principal - (`string `_) Identifies the entity (if any) responsible for terminating the execution - - - - -.. _api_msg_flyteidl.admin.ExecutionClosure: - -flyteidl.admin.ExecutionClosure -------------------------------- - -`[flyteidl.admin.ExecutionClosure proto] `_ - -Encapsulates the results of the Execution - -.. code-block:: json - - { - "outputs": "{...}", - "error": "{...}", - "abort_cause": "...", - "abort_metadata": "{...}", - "computed_inputs": "{...}", - "phase": "...", - "started_at": "{...}", - "duration": "{...}", - "created_at": "{...}", - "updated_at": "{...}", - "notifications": [], - "workflow_id": "{...}" - } - -.. _api_field_flyteidl.admin.ExecutionClosure.outputs: - -outputs - (:ref:`flyteidl.admin.LiteralMapBlob `) A map of outputs in the case of a successful execution. - - A result produced by a terminated execution. - A pending (non-terminal) execution will not have any output result. - - - Only one of :ref:`outputs `, :ref:`error `, :ref:`abort_cause `, :ref:`abort_metadata ` may be set. - -.. _api_field_flyteidl.admin.ExecutionClosure.error: - -error - (:ref:`flyteidl.core.ExecutionError `) Error information in the case of a failed execution. - - A result produced by a terminated execution. - A pending (non-terminal) execution will not have any output result. - - - Only one of :ref:`outputs `, :ref:`error `, :ref:`abort_cause `, :ref:`abort_metadata ` may be set. - -.. _api_field_flyteidl.admin.ExecutionClosure.abort_cause: - -abort_cause - (`string `_) In the case of a user-specified abort, this will pass along the user-supplied cause. - - A result produced by a terminated execution. - A pending (non-terminal) execution will not have any output result. - - - Only one of :ref:`outputs `, :ref:`error `, :ref:`abort_cause `, :ref:`abort_metadata ` may be set. - -.. _api_field_flyteidl.admin.ExecutionClosure.abort_metadata: - -abort_metadata - (:ref:`flyteidl.admin.AbortMetadata `) In the case of a user-specified abort, this will pass along the user and their supplied cause. - - A result produced by a terminated execution. - A pending (non-terminal) execution will not have any output result. - - - Only one of :ref:`outputs `, :ref:`error `, :ref:`abort_cause `, :ref:`abort_metadata ` may be set. - -.. _api_field_flyteidl.admin.ExecutionClosure.computed_inputs: - -computed_inputs - (:ref:`flyteidl.core.LiteralMap `) Inputs computed and passed for execution. - computed_inputs depends on inputs in ExecutionSpec, fixed and default inputs in launch plan - - -.. _api_field_flyteidl.admin.ExecutionClosure.phase: - -phase - (:ref:`flyteidl.core.WorkflowExecution.Phase `) Most recent recorded phase for the execution. - - -.. _api_field_flyteidl.admin.ExecutionClosure.started_at: - -started_at - (:ref:`google.protobuf.Timestamp `) Reported ime at which the execution began running. - - -.. _api_field_flyteidl.admin.ExecutionClosure.duration: - -duration - (:ref:`google.protobuf.Duration `) The amount of time the execution spent running. - - -.. _api_field_flyteidl.admin.ExecutionClosure.created_at: - -created_at - (:ref:`google.protobuf.Timestamp `) Reported time at which the execution was created. - - -.. _api_field_flyteidl.admin.ExecutionClosure.updated_at: - -updated_at - (:ref:`google.protobuf.Timestamp `) Reported time at which the execution was last updated. - - -.. _api_field_flyteidl.admin.ExecutionClosure.notifications: - -notifications - (:ref:`flyteidl.admin.Notification `) The notification settings to use after merging the CreateExecutionRequest and the launch plan - notification settings. An execution launched with notifications will always prefer that definition - to notifications defined statically in a launch plan. - - -.. _api_field_flyteidl.admin.ExecutionClosure.workflow_id: - -workflow_id - (:ref:`flyteidl.core.Identifier `) Identifies the workflow definition for this execution. - - - - -.. _api_msg_flyteidl.admin.SystemMetadata: - -flyteidl.admin.SystemMetadata ------------------------------ - -`[flyteidl.admin.SystemMetadata proto] `_ - -Represents system rather than user-facing metadata about an execution. - -.. code-block:: json - - { - "execution_cluster": "..." - } - -.. _api_field_flyteidl.admin.SystemMetadata.execution_cluster: - -execution_cluster - (`string `_) Which execution cluster this execution ran on. - - - - -.. _api_msg_flyteidl.admin.ExecutionMetadata: - -flyteidl.admin.ExecutionMetadata --------------------------------- - -`[flyteidl.admin.ExecutionMetadata proto] `_ - -Represents attributes about an execution which are not required to launch the execution but are useful to record. -These attributes are assigned at launch time and do not change. - -.. code-block:: json - - { - "mode": "...", - "principal": "...", - "nesting": "...", - "scheduled_at": "{...}", - "parent_node_execution": "{...}", - "reference_execution": "{...}", - "system_metadata": "{...}" - } - -.. _api_field_flyteidl.admin.ExecutionMetadata.mode: - -mode - (:ref:`flyteidl.admin.ExecutionMetadata.ExecutionMode `) - -.. _api_field_flyteidl.admin.ExecutionMetadata.principal: - -principal - (`string `_) Identifier of the entity that triggered this execution. - For systems using back-end authentication any value set here will be discarded in favor of the - authenticated user context. - - -.. _api_field_flyteidl.admin.ExecutionMetadata.nesting: - -nesting - (`uint32 `_) Indicates the "nestedness" of this execution. - If a user launches a workflow execution, the default nesting is 0. - If this execution further launches a workflow (child workflow), the nesting level is incremented by 0 => 1 - Generally, if workflow at nesting level k launches a workflow then the child workflow will have - nesting = k + 1. - - -.. _api_field_flyteidl.admin.ExecutionMetadata.scheduled_at: - -scheduled_at - (:ref:`google.protobuf.Timestamp `) For scheduled executions, the requested time for execution for this specific schedule invocation. - - -.. _api_field_flyteidl.admin.ExecutionMetadata.parent_node_execution: - -parent_node_execution - (:ref:`flyteidl.core.NodeExecutionIdentifier `) Which subworkflow node launched this execution - - -.. _api_field_flyteidl.admin.ExecutionMetadata.reference_execution: - -reference_execution - (:ref:`flyteidl.core.WorkflowExecutionIdentifier `) Optional, a reference workflow execution related to this execution. - In the case of a relaunch, this references the original workflow execution. - - -.. _api_field_flyteidl.admin.ExecutionMetadata.system_metadata: - -system_metadata - (:ref:`flyteidl.admin.SystemMetadata `) Optional, platform-specific metadata about the execution. - In this the future this may be gated behind an ACL or some sort of authorization. - - - -.. _api_enum_flyteidl.admin.ExecutionMetadata.ExecutionMode: - -Enum flyteidl.admin.ExecutionMetadata.ExecutionMode ---------------------------------------------------- - -`[flyteidl.admin.ExecutionMetadata.ExecutionMode proto] `_ - -The method by which this execution was launched. - -.. _api_enum_value_flyteidl.admin.ExecutionMetadata.ExecutionMode.MANUAL: - -MANUAL - *(DEFAULT)* ⁣The default execution mode, MANUAL implies that an execution was launched by an individual. - - -.. _api_enum_value_flyteidl.admin.ExecutionMetadata.ExecutionMode.SCHEDULED: - -SCHEDULED - ⁣A schedule triggered this execution launch. - - -.. _api_enum_value_flyteidl.admin.ExecutionMetadata.ExecutionMode.SYSTEM: - -SYSTEM - ⁣A system process was responsible for launching this execution rather an individual. - - -.. _api_enum_value_flyteidl.admin.ExecutionMetadata.ExecutionMode.RELAUNCH: - -RELAUNCH - ⁣This execution was launched with identical inputs as a previous execution. - - -.. _api_enum_value_flyteidl.admin.ExecutionMetadata.ExecutionMode.CHILD_WORKFLOW: - -CHILD_WORKFLOW - ⁣This execution was triggered by another execution. - - - -.. _api_msg_flyteidl.admin.NotificationList: - -flyteidl.admin.NotificationList -------------------------------- - -`[flyteidl.admin.NotificationList proto] `_ - - -.. code-block:: json - - { - "notifications": [] - } - -.. _api_field_flyteidl.admin.NotificationList.notifications: - -notifications - (:ref:`flyteidl.admin.Notification `) - - - -.. _api_msg_flyteidl.admin.ExecutionSpec: - -flyteidl.admin.ExecutionSpec ----------------------------- - -`[flyteidl.admin.ExecutionSpec proto] `_ - -An ExecutionSpec encompasses all data used to launch this execution. The Spec does not change over the lifetime -of an execution as it progresses across phase changes.. - -.. code-block:: json - - { - "launch_plan": "{...}", - "inputs": "{...}", - "metadata": "{...}", - "notifications": "{...}", - "disable_all": "...", - "labels": "{...}", - "annotations": "{...}", - "security_context": "{...}", - "auth_role": "{...}", - "quality_of_service": "{...}" - } - -.. _api_field_flyteidl.admin.ExecutionSpec.launch_plan: - -launch_plan - (:ref:`flyteidl.core.Identifier `) Launch plan to be executed - - -.. _api_field_flyteidl.admin.ExecutionSpec.inputs: - -inputs - (:ref:`flyteidl.core.LiteralMap `) Input values to be passed for the execution - - -.. _api_field_flyteidl.admin.ExecutionSpec.metadata: - -metadata - (:ref:`flyteidl.admin.ExecutionMetadata `) Metadata for the execution - - -.. _api_field_flyteidl.admin.ExecutionSpec.notifications: - -notifications - (:ref:`flyteidl.admin.NotificationList `) List of notifications based on Execution status transitions - When this list is not empty it is used rather than any notifications defined in the referenced launch plan. - When this list is empty, the notifications defined for the launch plan will be applied. - - - - Only one of :ref:`notifications `, :ref:`disable_all ` may be set. - -.. _api_field_flyteidl.admin.ExecutionSpec.disable_all: - -disable_all - (`bool `_) This should be set to true if all notifications are intended to be disabled for this execution. - - - - Only one of :ref:`notifications `, :ref:`disable_all ` may be set. - -.. _api_field_flyteidl.admin.ExecutionSpec.labels: - -labels - (:ref:`flyteidl.admin.Labels `) Labels to apply to the execution resource. - - -.. _api_field_flyteidl.admin.ExecutionSpec.annotations: - -annotations - (:ref:`flyteidl.admin.Annotations `) Annotations to apply to the execution resource. - - -.. _api_field_flyteidl.admin.ExecutionSpec.security_context: - -security_context - (:ref:`flyteidl.core.SecurityContext `) Optional: security context override to apply this execution. - - -.. _api_field_flyteidl.admin.ExecutionSpec.auth_role: - -auth_role - (:ref:`flyteidl.admin.AuthRole `) Optional: auth override to apply this execution. - - -.. _api_field_flyteidl.admin.ExecutionSpec.quality_of_service: - -quality_of_service - (:ref:`flyteidl.core.QualityOfService `) Indicates the runtime priority of the execution. - - - - -.. _api_msg_flyteidl.admin.ExecutionTerminateRequest: - -flyteidl.admin.ExecutionTerminateRequest ----------------------------------------- - -`[flyteidl.admin.ExecutionTerminateRequest proto] `_ - -Request to terminate an in-progress execution. This action is irreversible. -If an execution is already terminated, this request will simply be a no-op. -This request will fail if it references a non-existent execution. -If the request succeeds the phase "ABORTED" will be recorded for the termination -with the optional cause added to the output_result. - -.. code-block:: json - - { - "id": "{...}", - "cause": "..." - } - -.. _api_field_flyteidl.admin.ExecutionTerminateRequest.id: - -id - (:ref:`flyteidl.core.WorkflowExecutionIdentifier `) Uniquely identifies the individual workflow execution to be terminated. - - -.. _api_field_flyteidl.admin.ExecutionTerminateRequest.cause: - -cause - (`string `_) Optional reason for aborting. - - - - -.. _api_msg_flyteidl.admin.ExecutionTerminateResponse: - -flyteidl.admin.ExecutionTerminateResponse ------------------------------------------ - -`[flyteidl.admin.ExecutionTerminateResponse proto] `_ - - -.. code-block:: json - - {} - - - - -.. _api_msg_flyteidl.admin.WorkflowExecutionGetDataRequest: - -flyteidl.admin.WorkflowExecutionGetDataRequest ----------------------------------------------- - -`[flyteidl.admin.WorkflowExecutionGetDataRequest proto] `_ - -Request structure to fetch inputs and output urls for an execution. - -.. code-block:: json - - { - "id": "{...}" - } - -.. _api_field_flyteidl.admin.WorkflowExecutionGetDataRequest.id: - -id - (:ref:`flyteidl.core.WorkflowExecutionIdentifier `) The identifier of the execution for which to fetch inputs and outputs. - - - - -.. _api_msg_flyteidl.admin.WorkflowExecutionGetDataResponse: - -flyteidl.admin.WorkflowExecutionGetDataResponse ------------------------------------------------ - -`[flyteidl.admin.WorkflowExecutionGetDataResponse proto] `_ - -Response structure for WorkflowExecutionGetDataRequest which contains inputs and outputs for an execution. - -.. code-block:: json - - { - "outputs": "{...}", - "inputs": "{...}", - "full_inputs": "{...}", - "full_outputs": "{...}" - } - -.. _api_field_flyteidl.admin.WorkflowExecutionGetDataResponse.outputs: - -outputs - (:ref:`flyteidl.admin.UrlBlob `) Signed url to fetch a core.LiteralMap of execution outputs. - - -.. _api_field_flyteidl.admin.WorkflowExecutionGetDataResponse.inputs: - -inputs - (:ref:`flyteidl.admin.UrlBlob `) Signed url to fetch a core.LiteralMap of execution inputs. - - -.. _api_field_flyteidl.admin.WorkflowExecutionGetDataResponse.full_inputs: - -full_inputs - (:ref:`flyteidl.core.LiteralMap `) Optional, full_inputs will only be populated if they are under a configured size threshold. - - -.. _api_field_flyteidl.admin.WorkflowExecutionGetDataResponse.full_outputs: - -full_outputs - (:ref:`flyteidl.core.LiteralMap `) Optional, full_outputs will only be populated if they are under a configured size threshold. - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/admin/index.rst b/flyteidl/gen/pb-protodoc/flyteidl/admin/index.rst deleted file mode 100644 index 9d1c4716df..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/admin/index.rst +++ /dev/null @@ -1,27 +0,0 @@ -Flyte Admin Service entities -============================ - -These are the control plane entities that can be used to communication with the -Flyte Admin service over gRPC or REST. The endpoint specification is defined in the -`admin service spec `__. - -.. toctree:: - :maxdepth: 1 - :caption: admin - :name: admintoc - - common.proto - event.proto - execution.proto - launch_plan.proto - matchable_resource.proto - node_execution.proto - notification.proto - project.proto - project_domain_attributes.proto - schedule.proto - task.proto - task_execution.proto - version.proto - workflow.proto - workflow_attributes.proto diff --git a/flyteidl/gen/pb-protodoc/flyteidl/admin/launch_plan.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/admin/launch_plan.proto.rst deleted file mode 100644 index 3dfede0bfe..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/admin/launch_plan.proto.rst +++ /dev/null @@ -1,480 +0,0 @@ -.. _api_file_flyteidl/admin/launch_plan.proto: - -launch_plan.proto -================================ - -.. _api_msg_flyteidl.admin.LaunchPlanCreateRequest: - -flyteidl.admin.LaunchPlanCreateRequest --------------------------------------- - -`[flyteidl.admin.LaunchPlanCreateRequest proto] `_ - -Request to register a launch plan. A LaunchPlanSpec may include a complete or incomplete set of inputs required -to launch a workflow execution. By default all launch plans are registered in state INACTIVE. If you wish to -set the state to ACTIVE, you must submit a LaunchPlanUpdateRequest, after you have created a launch plan. - -.. code-block:: json - - { - "id": "{...}", - "spec": "{...}" - } - -.. _api_field_flyteidl.admin.LaunchPlanCreateRequest.id: - -id - (:ref:`flyteidl.core.Identifier `) Uniquely identifies a launch plan entity. - - -.. _api_field_flyteidl.admin.LaunchPlanCreateRequest.spec: - -spec - (:ref:`flyteidl.admin.LaunchPlanSpec `) User-provided launch plan details, including reference workflow, inputs and other metadata. - - - - -.. _api_msg_flyteidl.admin.LaunchPlanCreateResponse: - -flyteidl.admin.LaunchPlanCreateResponse ---------------------------------------- - -`[flyteidl.admin.LaunchPlanCreateResponse proto] `_ - - -.. code-block:: json - - {} - - - - -.. _api_msg_flyteidl.admin.LaunchPlan: - -flyteidl.admin.LaunchPlan -------------------------- - -`[flyteidl.admin.LaunchPlan proto] `_ - -A LaunchPlan provides the capability to templatize workflow executions. -Launch plans simplify associating one or more schedules, inputs and notifications with your workflows. -Launch plans can be shared and used to trigger executions with predefined inputs even when a workflow -definition doesn't necessarily have a default value for said input. - -.. code-block:: json - - { - "id": "{...}", - "spec": "{...}", - "closure": "{...}" - } - -.. _api_field_flyteidl.admin.LaunchPlan.id: - -id - (:ref:`flyteidl.core.Identifier `) - -.. _api_field_flyteidl.admin.LaunchPlan.spec: - -spec - (:ref:`flyteidl.admin.LaunchPlanSpec `) - -.. _api_field_flyteidl.admin.LaunchPlan.closure: - -closure - (:ref:`flyteidl.admin.LaunchPlanClosure `) - - - -.. _api_msg_flyteidl.admin.LaunchPlanList: - -flyteidl.admin.LaunchPlanList ------------------------------ - -`[flyteidl.admin.LaunchPlanList proto] `_ - -Response object for list launch plan requests. - -.. code-block:: json - - { - "launch_plans": [], - "token": "..." - } - -.. _api_field_flyteidl.admin.LaunchPlanList.launch_plans: - -launch_plans - (:ref:`flyteidl.admin.LaunchPlan `) - -.. _api_field_flyteidl.admin.LaunchPlanList.token: - -token - (`string `_) In the case of multiple pages of results, the server-provided token can be used to fetch the next page - in a query. If there are no more results, this value will be empty. - - - - -.. _api_msg_flyteidl.admin.Auth: - -flyteidl.admin.Auth -------------------- - -`[flyteidl.admin.Auth proto] `_ - -Defines permissions associated with executions created by this launch plan spec. -Deprecated. - -.. code-block:: json - - { - "assumable_iam_role": "...", - "kubernetes_service_account": "..." - } - -.. _api_field_flyteidl.admin.Auth.assumable_iam_role: - -assumable_iam_role - (`string `_) - - - Only one of :ref:`assumable_iam_role `, :ref:`kubernetes_service_account ` may be set. - -.. _api_field_flyteidl.admin.Auth.kubernetes_service_account: - -kubernetes_service_account - (`string `_) - - - Only one of :ref:`assumable_iam_role `, :ref:`kubernetes_service_account ` may be set. - - - -.. _api_msg_flyteidl.admin.LaunchPlanSpec: - -flyteidl.admin.LaunchPlanSpec ------------------------------ - -`[flyteidl.admin.LaunchPlanSpec proto] `_ - -User-provided launch plan definition and configuration values. - -.. code-block:: json - - { - "workflow_id": "{...}", - "entity_metadata": "{...}", - "default_inputs": "{...}", - "fixed_inputs": "{...}", - "role": "...", - "labels": "{...}", - "annotations": "{...}", - "auth": "{...}", - "auth_role": "{...}", - "security_context": "{...}", - "quality_of_service": "{...}", - "raw_output_data_config": "{...}" - } - -.. _api_field_flyteidl.admin.LaunchPlanSpec.workflow_id: - -workflow_id - (:ref:`flyteidl.core.Identifier `) Reference to the Workflow template that the launch plan references - - -.. _api_field_flyteidl.admin.LaunchPlanSpec.entity_metadata: - -entity_metadata - (:ref:`flyteidl.admin.LaunchPlanMetadata `) Metadata for the Launch Plan - - -.. _api_field_flyteidl.admin.LaunchPlanSpec.default_inputs: - -default_inputs - (:ref:`flyteidl.core.ParameterMap `) Input values to be passed for the execution - - -.. _api_field_flyteidl.admin.LaunchPlanSpec.fixed_inputs: - -fixed_inputs - (:ref:`flyteidl.core.LiteralMap `) Fixed, non-overridable inputs for the Launch Plan - - -.. _api_field_flyteidl.admin.LaunchPlanSpec.role: - -role - (`string `_) String to indicate the role to use to execute the workflow underneath - - -.. _api_field_flyteidl.admin.LaunchPlanSpec.labels: - -labels - (:ref:`flyteidl.admin.Labels `) Custom labels to be applied to the execution resource. - - -.. _api_field_flyteidl.admin.LaunchPlanSpec.annotations: - -annotations - (:ref:`flyteidl.admin.Annotations `) Custom annotations to be applied to the execution resource. - - -.. _api_field_flyteidl.admin.LaunchPlanSpec.auth: - -auth - (:ref:`flyteidl.admin.Auth `) Indicates the permission associated with workflow executions triggered with this launch plan. - - -.. _api_field_flyteidl.admin.LaunchPlanSpec.auth_role: - -auth_role - (:ref:`flyteidl.admin.AuthRole `) - -.. _api_field_flyteidl.admin.LaunchPlanSpec.security_context: - -security_context - (:ref:`flyteidl.core.SecurityContext `) Indicates security context for permissions triggered with this launch plan - - -.. _api_field_flyteidl.admin.LaunchPlanSpec.quality_of_service: - -quality_of_service - (:ref:`flyteidl.core.QualityOfService `) Indicates the runtime priority of the execution. - - -.. _api_field_flyteidl.admin.LaunchPlanSpec.raw_output_data_config: - -raw_output_data_config - (:ref:`flyteidl.admin.RawOutputDataConfig `) - - - -.. _api_msg_flyteidl.admin.LaunchPlanClosure: - -flyteidl.admin.LaunchPlanClosure --------------------------------- - -`[flyteidl.admin.LaunchPlanClosure proto] `_ - -Values computed by the flyte platform after launch plan registration. -These include expected_inputs required to be present in a CreateExecutionRequest -to launch the reference workflow as well timestamp values associated with the launch plan. - -.. code-block:: json - - { - "state": "...", - "expected_inputs": "{...}", - "expected_outputs": "{...}", - "created_at": "{...}", - "updated_at": "{...}" - } - -.. _api_field_flyteidl.admin.LaunchPlanClosure.state: - -state - (:ref:`flyteidl.admin.LaunchPlanState `) Indicate the Launch plan phase - - -.. _api_field_flyteidl.admin.LaunchPlanClosure.expected_inputs: - -expected_inputs - (:ref:`flyteidl.core.ParameterMap `) Indicates the set of inputs to execute the Launch plan - - -.. _api_field_flyteidl.admin.LaunchPlanClosure.expected_outputs: - -expected_outputs - (:ref:`flyteidl.core.VariableMap `) Indicates the set of outputs from the Launch plan - - -.. _api_field_flyteidl.admin.LaunchPlanClosure.created_at: - -created_at - (:ref:`google.protobuf.Timestamp `) Time at which the launch plan was created. - - -.. _api_field_flyteidl.admin.LaunchPlanClosure.updated_at: - -updated_at - (:ref:`google.protobuf.Timestamp `) Time at which the launch plan was last updated. - - - - -.. _api_msg_flyteidl.admin.LaunchPlanMetadata: - -flyteidl.admin.LaunchPlanMetadata ---------------------------------- - -`[flyteidl.admin.LaunchPlanMetadata proto] `_ - -Additional launch plan attributes included in the LaunchPlanSpec not strictly required to launch -the reference workflow. - -.. code-block:: json - - { - "schedule": "{...}", - "notifications": [] - } - -.. _api_field_flyteidl.admin.LaunchPlanMetadata.schedule: - -schedule - (:ref:`flyteidl.admin.Schedule `) Schedule to execute the Launch Plan - - -.. _api_field_flyteidl.admin.LaunchPlanMetadata.notifications: - -notifications - (:ref:`flyteidl.admin.Notification `) List of notifications based on Execution status transitions - - - - -.. _api_msg_flyteidl.admin.LaunchPlanUpdateRequest: - -flyteidl.admin.LaunchPlanUpdateRequest --------------------------------------- - -`[flyteidl.admin.LaunchPlanUpdateRequest proto] `_ - -Request to set the referenced launch plan state to the configured value. - -.. code-block:: json - - { - "id": "{...}", - "state": "..." - } - -.. _api_field_flyteidl.admin.LaunchPlanUpdateRequest.id: - -id - (:ref:`flyteidl.core.Identifier `) Identifier of launch plan for which to change state. - - -.. _api_field_flyteidl.admin.LaunchPlanUpdateRequest.state: - -state - (:ref:`flyteidl.admin.LaunchPlanState `) Desired state to apply to the launch plan. - - - - -.. _api_msg_flyteidl.admin.LaunchPlanUpdateResponse: - -flyteidl.admin.LaunchPlanUpdateResponse ---------------------------------------- - -`[flyteidl.admin.LaunchPlanUpdateResponse proto] `_ - -Purposefully empty, may be populated in the future. - -.. code-block:: json - - {} - - - - -.. _api_msg_flyteidl.admin.ActiveLaunchPlanRequest: - -flyteidl.admin.ActiveLaunchPlanRequest --------------------------------------- - -`[flyteidl.admin.ActiveLaunchPlanRequest proto] `_ - -Represents a request struct for finding an active launch plan for a given NamedEntityIdentifier - -.. code-block:: json - - { - "id": "{...}" - } - -.. _api_field_flyteidl.admin.ActiveLaunchPlanRequest.id: - -id - (:ref:`flyteidl.admin.NamedEntityIdentifier `) - - - -.. _api_msg_flyteidl.admin.ActiveLaunchPlanListRequest: - -flyteidl.admin.ActiveLaunchPlanListRequest ------------------------------------------- - -`[flyteidl.admin.ActiveLaunchPlanListRequest proto] `_ - -Represents a request structure to list active launch plans within a project/domain. - -.. code-block:: json - - { - "project": "...", - "domain": "...", - "limit": "...", - "token": "...", - "sort_by": "{...}" - } - -.. _api_field_flyteidl.admin.ActiveLaunchPlanListRequest.project: - -project - (`string `_) Name of the project that contains the identifiers. - - -.. _api_field_flyteidl.admin.ActiveLaunchPlanListRequest.domain: - -domain - (`string `_) Name of the domain the identifiers belongs to within the project. - - -.. _api_field_flyteidl.admin.ActiveLaunchPlanListRequest.limit: - -limit - (`uint32 `_) Indicates the number of resources to be returned. - - -.. _api_field_flyteidl.admin.ActiveLaunchPlanListRequest.token: - -token - (`string `_) In the case of multiple pages of results, the server-provided token can be used to fetch the next page - in a query. - +optional - - -.. _api_field_flyteidl.admin.ActiveLaunchPlanListRequest.sort_by: - -sort_by - (:ref:`flyteidl.admin.Sort `) Sort ordering. - +optional - - - -.. _api_enum_flyteidl.admin.LaunchPlanState: - -Enum flyteidl.admin.LaunchPlanState ------------------------------------ - -`[flyteidl.admin.LaunchPlanState proto] `_ - -By default any launch plan regardless of state can be used to launch a workflow execution. -However, at most one version of a launch plan -(e.g. a NamedEntityIdentifier set of shared project, domain and name values) can be -active at a time in regards to *schedules*. That is, at most one schedule in a NamedEntityIdentifier -group will be observed and trigger executions at a defined cadence. - -.. _api_enum_value_flyteidl.admin.LaunchPlanState.INACTIVE: - -INACTIVE - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.admin.LaunchPlanState.ACTIVE: - -ACTIVE - ⁣ - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/admin/matchable_resource.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/admin/matchable_resource.proto.rst deleted file mode 100644 index 2be640279b..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/admin/matchable_resource.proto.rst +++ /dev/null @@ -1,424 +0,0 @@ -.. _api_file_flyteidl/admin/matchable_resource.proto: - -matchable_resource.proto -======================================= - -.. _api_msg_flyteidl.admin.TaskResourceSpec: - -flyteidl.admin.TaskResourceSpec -------------------------------- - -`[flyteidl.admin.TaskResourceSpec proto] `_ - - -.. code-block:: json - - { - "cpu": "...", - "gpu": "...", - "memory": "...", - "storage": "..." - } - -.. _api_field_flyteidl.admin.TaskResourceSpec.cpu: - -cpu - (`string `_) - -.. _api_field_flyteidl.admin.TaskResourceSpec.gpu: - -gpu - (`string `_) - -.. _api_field_flyteidl.admin.TaskResourceSpec.memory: - -memory - (`string `_) - -.. _api_field_flyteidl.admin.TaskResourceSpec.storage: - -storage - (`string `_) - - - -.. _api_msg_flyteidl.admin.TaskResourceAttributes: - -flyteidl.admin.TaskResourceAttributes -------------------------------------- - -`[flyteidl.admin.TaskResourceAttributes proto] `_ - - -.. code-block:: json - - { - "defaults": "{...}", - "limits": "{...}" - } - -.. _api_field_flyteidl.admin.TaskResourceAttributes.defaults: - -defaults - (:ref:`flyteidl.admin.TaskResourceSpec `) - -.. _api_field_flyteidl.admin.TaskResourceAttributes.limits: - -limits - (:ref:`flyteidl.admin.TaskResourceSpec `) - - - -.. _api_msg_flyteidl.admin.ClusterResourceAttributes: - -flyteidl.admin.ClusterResourceAttributes ----------------------------------------- - -`[flyteidl.admin.ClusterResourceAttributes proto] `_ - - -.. code-block:: json - - { - "attributes": "{...}" - } - -.. _api_field_flyteidl.admin.ClusterResourceAttributes.attributes: - -attributes - (map<`string `_, `string `_>) Custom resource attributes which will be applied in cluster resource creation (e.g. quotas). - Map keys are the *case-sensitive* names of variables in templatized resource files. - Map values should be the custom values which get substituted during resource creation. - - - - -.. _api_msg_flyteidl.admin.ExecutionQueueAttributes: - -flyteidl.admin.ExecutionQueueAttributes ---------------------------------------- - -`[flyteidl.admin.ExecutionQueueAttributes proto] `_ - - -.. code-block:: json - - { - "tags": [] - } - -.. _api_field_flyteidl.admin.ExecutionQueueAttributes.tags: - -tags - (`string `_) Tags used for assigning execution queues for tasks defined within this project. - - - - -.. _api_msg_flyteidl.admin.ExecutionClusterLabel: - -flyteidl.admin.ExecutionClusterLabel ------------------------------------- - -`[flyteidl.admin.ExecutionClusterLabel proto] `_ - - -.. code-block:: json - - { - "value": "..." - } - -.. _api_field_flyteidl.admin.ExecutionClusterLabel.value: - -value - (`string `_) Label value to determine where the execution will be run - - - - -.. _api_msg_flyteidl.admin.PluginOverride: - -flyteidl.admin.PluginOverride ------------------------------ - -`[flyteidl.admin.PluginOverride proto] `_ - -This MatchableAttribute configures selecting alternate plugin implementations for a given task type. -In addition to an override implementation a selection of fallbacks can be provided or other modes -for handling cases where the desired plugin override is not enabled in a given Flyte deployment. - -.. code-block:: json - - { - "task_type": "...", - "plugin_id": [], - "missing_plugin_behavior": "..." - } - -.. _api_field_flyteidl.admin.PluginOverride.task_type: - -task_type - (`string `_) A predefined yet extensible Task type identifier. - - -.. _api_field_flyteidl.admin.PluginOverride.plugin_id: - -plugin_id - (`string `_) A set of plugin ids which should handle tasks of this type instead of the default registered plugin. The list will be tried in order until a plugin is found with that id. - - -.. _api_field_flyteidl.admin.PluginOverride.missing_plugin_behavior: - -missing_plugin_behavior - (:ref:`flyteidl.admin.PluginOverride.MissingPluginBehavior `) Defines the behavior when no plugin from the plugin_id list is not found. - - - -.. _api_enum_flyteidl.admin.PluginOverride.MissingPluginBehavior: - -Enum flyteidl.admin.PluginOverride.MissingPluginBehavior --------------------------------------------------------- - -`[flyteidl.admin.PluginOverride.MissingPluginBehavior proto] `_ - - -.. _api_enum_value_flyteidl.admin.PluginOverride.MissingPluginBehavior.FAIL: - -FAIL - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.admin.PluginOverride.MissingPluginBehavior.USE_DEFAULT: - -USE_DEFAULT - ⁣Uses the system-configured default implementation. - - - -.. _api_msg_flyteidl.admin.PluginOverrides: - -flyteidl.admin.PluginOverrides ------------------------------- - -`[flyteidl.admin.PluginOverrides proto] `_ - - -.. code-block:: json - - { - "overrides": [] - } - -.. _api_field_flyteidl.admin.PluginOverrides.overrides: - -overrides - (:ref:`flyteidl.admin.PluginOverride `) - - - -.. _api_msg_flyteidl.admin.MatchingAttributes: - -flyteidl.admin.MatchingAttributes ---------------------------------- - -`[flyteidl.admin.MatchingAttributes proto] `_ - -Generic container for encapsulating all types of the above attributes messages. - -.. code-block:: json - - { - "task_resource_attributes": "{...}", - "cluster_resource_attributes": "{...}", - "execution_queue_attributes": "{...}", - "execution_cluster_label": "{...}", - "quality_of_service": "{...}", - "plugin_overrides": "{...}" - } - -.. _api_field_flyteidl.admin.MatchingAttributes.task_resource_attributes: - -task_resource_attributes - (:ref:`flyteidl.admin.TaskResourceAttributes `) - - - Only one of :ref:`task_resource_attributes `, :ref:`cluster_resource_attributes `, :ref:`execution_queue_attributes `, :ref:`execution_cluster_label `, :ref:`quality_of_service `, :ref:`plugin_overrides ` may be set. - -.. _api_field_flyteidl.admin.MatchingAttributes.cluster_resource_attributes: - -cluster_resource_attributes - (:ref:`flyteidl.admin.ClusterResourceAttributes `) - - - Only one of :ref:`task_resource_attributes `, :ref:`cluster_resource_attributes `, :ref:`execution_queue_attributes `, :ref:`execution_cluster_label `, :ref:`quality_of_service `, :ref:`plugin_overrides ` may be set. - -.. _api_field_flyteidl.admin.MatchingAttributes.execution_queue_attributes: - -execution_queue_attributes - (:ref:`flyteidl.admin.ExecutionQueueAttributes `) - - - Only one of :ref:`task_resource_attributes `, :ref:`cluster_resource_attributes `, :ref:`execution_queue_attributes `, :ref:`execution_cluster_label `, :ref:`quality_of_service `, :ref:`plugin_overrides ` may be set. - -.. _api_field_flyteidl.admin.MatchingAttributes.execution_cluster_label: - -execution_cluster_label - (:ref:`flyteidl.admin.ExecutionClusterLabel `) - - - Only one of :ref:`task_resource_attributes `, :ref:`cluster_resource_attributes `, :ref:`execution_queue_attributes `, :ref:`execution_cluster_label `, :ref:`quality_of_service `, :ref:`plugin_overrides ` may be set. - -.. _api_field_flyteidl.admin.MatchingAttributes.quality_of_service: - -quality_of_service - (:ref:`flyteidl.core.QualityOfService `) - - - Only one of :ref:`task_resource_attributes `, :ref:`cluster_resource_attributes `, :ref:`execution_queue_attributes `, :ref:`execution_cluster_label `, :ref:`quality_of_service `, :ref:`plugin_overrides ` may be set. - -.. _api_field_flyteidl.admin.MatchingAttributes.plugin_overrides: - -plugin_overrides - (:ref:`flyteidl.admin.PluginOverrides `) - - - Only one of :ref:`task_resource_attributes `, :ref:`cluster_resource_attributes `, :ref:`execution_queue_attributes `, :ref:`execution_cluster_label `, :ref:`quality_of_service `, :ref:`plugin_overrides ` may be set. - - - -.. _api_msg_flyteidl.admin.MatchableAttributesConfiguration: - -flyteidl.admin.MatchableAttributesConfiguration ------------------------------------------------ - -`[flyteidl.admin.MatchableAttributesConfiguration proto] `_ - -Represents a custom set of attributes applied for either a domain; a domain and project; or -domain, project and workflow name. - -.. code-block:: json - - { - "attributes": "{...}", - "domain": "...", - "project": "...", - "workflow": "...", - "launch_plan": "..." - } - -.. _api_field_flyteidl.admin.MatchableAttributesConfiguration.attributes: - -attributes - (:ref:`flyteidl.admin.MatchingAttributes `) - -.. _api_field_flyteidl.admin.MatchableAttributesConfiguration.domain: - -domain - (`string `_) - -.. _api_field_flyteidl.admin.MatchableAttributesConfiguration.project: - -project - (`string `_) - -.. _api_field_flyteidl.admin.MatchableAttributesConfiguration.workflow: - -workflow - (`string `_) - -.. _api_field_flyteidl.admin.MatchableAttributesConfiguration.launch_plan: - -launch_plan - (`string `_) - - - -.. _api_msg_flyteidl.admin.ListMatchableAttributesRequest: - -flyteidl.admin.ListMatchableAttributesRequest ---------------------------------------------- - -`[flyteidl.admin.ListMatchableAttributesRequest proto] `_ - -Request all matching resource attributes. - -.. code-block:: json - - { - "resource_type": "..." - } - -.. _api_field_flyteidl.admin.ListMatchableAttributesRequest.resource_type: - -resource_type - (:ref:`flyteidl.admin.MatchableResource `) - - - -.. _api_msg_flyteidl.admin.ListMatchableAttributesResponse: - -flyteidl.admin.ListMatchableAttributesResponse ----------------------------------------------- - -`[flyteidl.admin.ListMatchableAttributesResponse proto] `_ - -Response for a request for all matching resource attributes. - -.. code-block:: json - - { - "configurations": [] - } - -.. _api_field_flyteidl.admin.ListMatchableAttributesResponse.configurations: - -configurations - (:ref:`flyteidl.admin.MatchableAttributesConfiguration `) - - -.. _api_enum_flyteidl.admin.MatchableResource: - -Enum flyteidl.admin.MatchableResource -------------------------------------- - -`[flyteidl.admin.MatchableResource proto] `_ - -Defines a resource that can be configured by customizable Project-, ProjectDomain- or WorkflowAttributes -based on matching tags. - -.. _api_enum_value_flyteidl.admin.MatchableResource.TASK_RESOURCE: - -TASK_RESOURCE - *(DEFAULT)* ⁣Applies to customizable task resource requests and limits. - - -.. _api_enum_value_flyteidl.admin.MatchableResource.CLUSTER_RESOURCE: - -CLUSTER_RESOURCE - ⁣Applies to configuring templated kubernetes cluster resources. - - -.. _api_enum_value_flyteidl.admin.MatchableResource.EXECUTION_QUEUE: - -EXECUTION_QUEUE - ⁣Configures task and dynamic task execution queue assignment. - - -.. _api_enum_value_flyteidl.admin.MatchableResource.EXECUTION_CLUSTER_LABEL: - -EXECUTION_CLUSTER_LABEL - ⁣Configures the K8s cluster label to be used for execution to be run - - -.. _api_enum_value_flyteidl.admin.MatchableResource.QUALITY_OF_SERVICE_SPECIFICATION: - -QUALITY_OF_SERVICE_SPECIFICATION - ⁣Configures default quality of service when undefined in an execution spec. - - -.. _api_enum_value_flyteidl.admin.MatchableResource.PLUGIN_OVERRIDE: - -PLUGIN_OVERRIDE - ⁣Selects configurable plugin implementation behavior for a given task type. - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/admin/node_execution.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/admin/node_execution.proto.rst deleted file mode 100644 index b725fb2070..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/admin/node_execution.proto.rst +++ /dev/null @@ -1,513 +0,0 @@ -.. _api_file_flyteidl/admin/node_execution.proto: - -node_execution.proto -=================================== - -.. _api_msg_flyteidl.admin.NodeExecutionGetRequest: - -flyteidl.admin.NodeExecutionGetRequest --------------------------------------- - -`[flyteidl.admin.NodeExecutionGetRequest proto] `_ - -A message used to fetch a single node execution entity. - -.. code-block:: json - - { - "id": "{...}" - } - -.. _api_field_flyteidl.admin.NodeExecutionGetRequest.id: - -id - (:ref:`flyteidl.core.NodeExecutionIdentifier `) Uniquely identifies an individual node execution. - - - - -.. _api_msg_flyteidl.admin.NodeExecutionListRequest: - -flyteidl.admin.NodeExecutionListRequest ---------------------------------------- - -`[flyteidl.admin.NodeExecutionListRequest proto] `_ - -Represents a request structure to retrieve a list of node execution entities. - -.. code-block:: json - - { - "workflow_execution_id": "{...}", - "limit": "...", - "token": "...", - "filters": "...", - "sort_by": "{...}", - "unique_parent_id": "..." - } - -.. _api_field_flyteidl.admin.NodeExecutionListRequest.workflow_execution_id: - -workflow_execution_id - (:ref:`flyteidl.core.WorkflowExecutionIdentifier `) Indicates the workflow execution to filter by. - - -.. _api_field_flyteidl.admin.NodeExecutionListRequest.limit: - -limit - (`uint32 `_) Indicates the number of resources to be returned. - - -.. _api_field_flyteidl.admin.NodeExecutionListRequest.token: - -token - (`string `_) In the case of multiple pages of results, the, server-provided token can be used to fetch the next page - in a query. - +optional - - -.. _api_field_flyteidl.admin.NodeExecutionListRequest.filters: - -filters - (`string `_) Indicates a list of filters passed as string. - More info on constructing filters : - +optional - - -.. _api_field_flyteidl.admin.NodeExecutionListRequest.sort_by: - -sort_by - (:ref:`flyteidl.admin.Sort `) Sort ordering. - +optional - - -.. _api_field_flyteidl.admin.NodeExecutionListRequest.unique_parent_id: - -unique_parent_id - (`string `_) Unique identifier of the parent node in the execution - +optional - - - - -.. _api_msg_flyteidl.admin.NodeExecutionForTaskListRequest: - -flyteidl.admin.NodeExecutionForTaskListRequest ----------------------------------------------- - -`[flyteidl.admin.NodeExecutionForTaskListRequest proto] `_ - -Represents a request structure to retrieve a list of node execution entities launched by a specific task. - -.. code-block:: json - - { - "task_execution_id": "{...}", - "limit": "...", - "token": "...", - "filters": "...", - "sort_by": "{...}" - } - -.. _api_field_flyteidl.admin.NodeExecutionForTaskListRequest.task_execution_id: - -task_execution_id - (:ref:`flyteidl.core.TaskExecutionIdentifier `) Indicates the node execution to filter by. - - -.. _api_field_flyteidl.admin.NodeExecutionForTaskListRequest.limit: - -limit - (`uint32 `_) Indicates the number of resources to be returned. - - -.. _api_field_flyteidl.admin.NodeExecutionForTaskListRequest.token: - -token - (`string `_) In the case of multiple pages of results, the, server-provided token can be used to fetch the next page - in a query. - +optional - - -.. _api_field_flyteidl.admin.NodeExecutionForTaskListRequest.filters: - -filters - (`string `_) Indicates a list of filters passed as string. - More info on constructing filters : - +optional - - -.. _api_field_flyteidl.admin.NodeExecutionForTaskListRequest.sort_by: - -sort_by - (:ref:`flyteidl.admin.Sort `) Sort ordering. - +optional - - - - -.. _api_msg_flyteidl.admin.NodeExecution: - -flyteidl.admin.NodeExecution ----------------------------- - -`[flyteidl.admin.NodeExecution proto] `_ - -Encapsulates all details for a single node execution entity. -A node represents a component in the overall workflow graph. A node launch a task, multiple tasks, an entire nested -sub-workflow, or even a separate child-workflow execution. -The same task can be called repeatedly in a single workflow but each node is unique. - -.. code-block:: json - - { - "id": "{...}", - "input_uri": "...", - "closure": "{...}", - "metadata": "{...}" - } - -.. _api_field_flyteidl.admin.NodeExecution.id: - -id - (:ref:`flyteidl.core.NodeExecutionIdentifier `) Uniquely identifies an individual node execution. - - -.. _api_field_flyteidl.admin.NodeExecution.input_uri: - -input_uri - (`string `_) Path to remote data store where input blob is stored. - - -.. _api_field_flyteidl.admin.NodeExecution.closure: - -closure - (:ref:`flyteidl.admin.NodeExecutionClosure `) Computed results associated with this node execution. - - -.. _api_field_flyteidl.admin.NodeExecution.metadata: - -metadata - (:ref:`flyteidl.admin.NodeExecutionMetaData `) Metadata for Node Execution - - - - -.. _api_msg_flyteidl.admin.NodeExecutionMetaData: - -flyteidl.admin.NodeExecutionMetaData ------------------------------------- - -`[flyteidl.admin.NodeExecutionMetaData proto] `_ - -Represents additional attributes related to a Node Execution - -.. code-block:: json - - { - "retry_group": "...", - "is_parent_node": "...", - "spec_node_id": "..." - } - -.. _api_field_flyteidl.admin.NodeExecutionMetaData.retry_group: - -retry_group - (`string `_) Node executions are grouped depending on retries of the parent - Retry group is unique within the context of a parent node. - - -.. _api_field_flyteidl.admin.NodeExecutionMetaData.is_parent_node: - -is_parent_node - (`bool `_) Boolean flag indicating if the node has child nodes under it - - -.. _api_field_flyteidl.admin.NodeExecutionMetaData.spec_node_id: - -spec_node_id - (`string `_) Node id of the node in the original workflow - This maps to value of WorkflowTemplate.nodes[X].id - - - - -.. _api_msg_flyteidl.admin.NodeExecutionList: - -flyteidl.admin.NodeExecutionList --------------------------------- - -`[flyteidl.admin.NodeExecutionList proto] `_ - -Request structure to retrieve a list of node execution entities. - -.. code-block:: json - - { - "node_executions": [], - "token": "..." - } - -.. _api_field_flyteidl.admin.NodeExecutionList.node_executions: - -node_executions - (:ref:`flyteidl.admin.NodeExecution `) - -.. _api_field_flyteidl.admin.NodeExecutionList.token: - -token - (`string `_) In the case of multiple pages of results, the server-provided token can be used to fetch the next page - in a query. If there are no more results, this value will be empty. - - - - -.. _api_msg_flyteidl.admin.NodeExecutionClosure: - -flyteidl.admin.NodeExecutionClosure ------------------------------------ - -`[flyteidl.admin.NodeExecutionClosure proto] `_ - -Container for node execution details and results. - -.. code-block:: json - - { - "output_uri": "...", - "error": "{...}", - "phase": "...", - "started_at": "{...}", - "duration": "{...}", - "created_at": "{...}", - "updated_at": "{...}", - "workflow_node_metadata": "{...}", - "task_node_metadata": "{...}" - } - -.. _api_field_flyteidl.admin.NodeExecutionClosure.output_uri: - -output_uri - (`string `_) - Only a node in a terminal state will have a non-empty output_result. - - - Only one of :ref:`output_uri `, :ref:`error ` may be set. - -.. _api_field_flyteidl.admin.NodeExecutionClosure.error: - -error - (:ref:`flyteidl.core.ExecutionError `) Error information for the Node - - Only a node in a terminal state will have a non-empty output_result. - - - Only one of :ref:`output_uri `, :ref:`error ` may be set. - -.. _api_field_flyteidl.admin.NodeExecutionClosure.phase: - -phase - (:ref:`flyteidl.core.NodeExecution.Phase `) The last recorded phase for this node execution. - - -.. _api_field_flyteidl.admin.NodeExecutionClosure.started_at: - -started_at - (:ref:`google.protobuf.Timestamp `) Time at which the node execution began running. - - -.. _api_field_flyteidl.admin.NodeExecutionClosure.duration: - -duration - (:ref:`google.protobuf.Duration `) The amount of time the node execution spent running. - - -.. _api_field_flyteidl.admin.NodeExecutionClosure.created_at: - -created_at - (:ref:`google.protobuf.Timestamp `) Time at which the node execution was created. - - -.. _api_field_flyteidl.admin.NodeExecutionClosure.updated_at: - -updated_at - (:ref:`google.protobuf.Timestamp `) Time at which the node execution was last updated. - - -.. _api_field_flyteidl.admin.NodeExecutionClosure.workflow_node_metadata: - -workflow_node_metadata - (:ref:`flyteidl.admin.WorkflowNodeMetadata `) - Store metadata for what the node launched. - for ex: if this is a workflow node, we store information for the launched workflow. - - - Only one of :ref:`workflow_node_metadata `, :ref:`task_node_metadata ` may be set. - -.. _api_field_flyteidl.admin.NodeExecutionClosure.task_node_metadata: - -task_node_metadata - (:ref:`flyteidl.admin.TaskNodeMetadata `) - Store metadata for what the node launched. - for ex: if this is a workflow node, we store information for the launched workflow. - - - Only one of :ref:`workflow_node_metadata `, :ref:`task_node_metadata ` may be set. - - - -.. _api_msg_flyteidl.admin.WorkflowNodeMetadata: - -flyteidl.admin.WorkflowNodeMetadata ------------------------------------ - -`[flyteidl.admin.WorkflowNodeMetadata proto] `_ - -Metadata for a WorkflowNode - -.. code-block:: json - - { - "executionId": "{...}" - } - -.. _api_field_flyteidl.admin.WorkflowNodeMetadata.executionId: - -executionId - (:ref:`flyteidl.core.WorkflowExecutionIdentifier `) - - - -.. _api_msg_flyteidl.admin.TaskNodeMetadata: - -flyteidl.admin.TaskNodeMetadata -------------------------------- - -`[flyteidl.admin.TaskNodeMetadata proto] `_ - -Metadata for the case in which the node is a TaskNode - -.. code-block:: json - - { - "cache_status": "...", - "catalog_key": "{...}" - } - -.. _api_field_flyteidl.admin.TaskNodeMetadata.cache_status: - -cache_status - (:ref:`flyteidl.core.CatalogCacheStatus `) Captures the status of caching for this execution. - - -.. _api_field_flyteidl.admin.TaskNodeMetadata.catalog_key: - -catalog_key - (:ref:`flyteidl.core.CatalogMetadata `) This structure carries the catalog artifact information - - - - -.. _api_msg_flyteidl.admin.DynamicWorkflowNodeMetadata: - -flyteidl.admin.DynamicWorkflowNodeMetadata ------------------------------------------- - -`[flyteidl.admin.DynamicWorkflowNodeMetadata proto] `_ - -For dynamic workflow nodes we capture information about the dynamic workflow definition that gets generated. - -.. code-block:: json - - { - "id": "{...}", - "compiled_workflow": "{...}" - } - -.. _api_field_flyteidl.admin.DynamicWorkflowNodeMetadata.id: - -id - (:ref:`flyteidl.core.Identifier `) id represents the unique identifier of the workflow. - - -.. _api_field_flyteidl.admin.DynamicWorkflowNodeMetadata.compiled_workflow: - -compiled_workflow - (:ref:`flyteidl.core.CompiledWorkflowClosure `) Represents the compiled representation of the embedded dynamic workflow. - - - - -.. _api_msg_flyteidl.admin.NodeExecutionGetDataRequest: - -flyteidl.admin.NodeExecutionGetDataRequest ------------------------------------------- - -`[flyteidl.admin.NodeExecutionGetDataRequest proto] `_ - -Request structure to fetch inputs and output urls for a node execution. - -.. code-block:: json - - { - "id": "{...}" - } - -.. _api_field_flyteidl.admin.NodeExecutionGetDataRequest.id: - -id - (:ref:`flyteidl.core.NodeExecutionIdentifier `) The identifier of the node execution for which to fetch inputs and outputs. - - - - -.. _api_msg_flyteidl.admin.NodeExecutionGetDataResponse: - -flyteidl.admin.NodeExecutionGetDataResponse -------------------------------------------- - -`[flyteidl.admin.NodeExecutionGetDataResponse proto] `_ - -Response structure for NodeExecutionGetDataRequest which contains inputs and outputs for a node execution. - -.. code-block:: json - - { - "inputs": "{...}", - "outputs": "{...}", - "full_inputs": "{...}", - "full_outputs": "{...}", - "dynamic_workflow": "{...}" - } - -.. _api_field_flyteidl.admin.NodeExecutionGetDataResponse.inputs: - -inputs - (:ref:`flyteidl.admin.UrlBlob `) Signed url to fetch a core.LiteralMap of node execution inputs. - - -.. _api_field_flyteidl.admin.NodeExecutionGetDataResponse.outputs: - -outputs - (:ref:`flyteidl.admin.UrlBlob `) Signed url to fetch a core.LiteralMap of node execution outputs. - - -.. _api_field_flyteidl.admin.NodeExecutionGetDataResponse.full_inputs: - -full_inputs - (:ref:`flyteidl.core.LiteralMap `) Optional, full_inputs will only be populated if they are under a configured size threshold. - - -.. _api_field_flyteidl.admin.NodeExecutionGetDataResponse.full_outputs: - -full_outputs - (:ref:`flyteidl.core.LiteralMap `) Optional, full_outputs will only be populated if they are under a configured size threshold. - - -.. _api_field_flyteidl.admin.NodeExecutionGetDataResponse.dynamic_workflow: - -dynamic_workflow - (:ref:`flyteidl.admin.DynamicWorkflowNodeMetadata `) Optional Workflow closure for a dynamically generated workflow, in the case this node yields a dynamic workflow we return its structure here. - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/admin/notification.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/admin/notification.proto.rst deleted file mode 100644 index d6e46ae590..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/admin/notification.proto.rst +++ /dev/null @@ -1,57 +0,0 @@ -.. _api_file_flyteidl/admin/notification.proto: - -notification.proto -================================= - -import "validate/validate.proto"; - -.. _api_msg_flyteidl.admin.EmailMessage: - -flyteidl.admin.EmailMessage ---------------------------- - -`[flyteidl.admin.EmailMessage proto] `_ - -Represents the Email object that is sent to a publisher/subscriber -to forward the notification. -Note: This is internal to Admin and doesn't need to be exposed to other components. - -.. code-block:: json - - { - "recipients_email": [], - "sender_email": "...", - "subject_line": "...", - "body": "..." - } - -.. _api_field_flyteidl.admin.EmailMessage.recipients_email: - -recipients_email - (`string `_) The list of email addresses to receive an email with the content populated in the other fields. - Currently, each email recipient will receive its own email. - This populates the TO field. - - -.. _api_field_flyteidl.admin.EmailMessage.sender_email: - -sender_email - (`string `_) The email of the sender. - This populates the FROM field. - - -.. _api_field_flyteidl.admin.EmailMessage.subject_line: - -subject_line - (`string `_) The content of the subject line. - This populates the SUBJECT field. - - -.. _api_field_flyteidl.admin.EmailMessage.body: - -body - (`string `_) The content of the email body. - This populates the BODY field. - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/admin/project.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/admin/project.proto.rst deleted file mode 100644 index 4fb66ecb14..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/admin/project.proto.rst +++ /dev/null @@ -1,244 +0,0 @@ -.. _api_file_flyteidl/admin/project.proto: - -project.proto -============================ - -.. _api_msg_flyteidl.admin.Domain: - -flyteidl.admin.Domain ---------------------- - -`[flyteidl.admin.Domain proto] `_ - -Namespace within a project commonly used to differentiate between different service instances. -e.g. "production", "development", etc. - -.. code-block:: json - - { - "id": "...", - "name": "..." - } - -.. _api_field_flyteidl.admin.Domain.id: - -id - (`string `_) - -.. _api_field_flyteidl.admin.Domain.name: - -name - (`string `_) Display name. - - - - -.. _api_msg_flyteidl.admin.Project: - -flyteidl.admin.Project ----------------------- - -`[flyteidl.admin.Project proto] `_ - -Top-level namespace used to classify different entities like workflows and executions. - -.. code-block:: json - - { - "id": "...", - "name": "...", - "domains": [], - "description": "...", - "labels": "{...}", - "state": "..." - } - -.. _api_field_flyteidl.admin.Project.id: - -id - (`string `_) - -.. _api_field_flyteidl.admin.Project.name: - -name - (`string `_) Display name. - - -.. _api_field_flyteidl.admin.Project.domains: - -domains - (:ref:`flyteidl.admin.Domain `) - -.. _api_field_flyteidl.admin.Project.description: - -description - (`string `_) - -.. _api_field_flyteidl.admin.Project.labels: - -labels - (:ref:`flyteidl.admin.Labels `) Leverage Labels from flyteidel.admin.common.proto to - tag projects with ownership information. - - -.. _api_field_flyteidl.admin.Project.state: - -state - (:ref:`flyteidl.admin.Project.ProjectState `) - - -.. _api_enum_flyteidl.admin.Project.ProjectState: - -Enum flyteidl.admin.Project.ProjectState ----------------------------------------- - -`[flyteidl.admin.Project.ProjectState proto] `_ - -The state of the project is used to control its visibility in the UI and validity. - -.. _api_enum_value_flyteidl.admin.Project.ProjectState.ACTIVE: - -ACTIVE - *(DEFAULT)* ⁣By default, all projects are considered active. - - -.. _api_enum_value_flyteidl.admin.Project.ProjectState.ARCHIVED: - -ARCHIVED - ⁣Archived projects are no longer visible in the UI and no longer valid. - - -.. _api_enum_value_flyteidl.admin.Project.ProjectState.SYSTEM_GENERATED: - -SYSTEM_GENERATED - ⁣System generated projects that aren't explicitly created or managed by a user. - - - -.. _api_msg_flyteidl.admin.Projects: - -flyteidl.admin.Projects ------------------------ - -`[flyteidl.admin.Projects proto] `_ - - -.. code-block:: json - - { - "projects": [], - "token": "..." - } - -.. _api_field_flyteidl.admin.Projects.projects: - -projects - (:ref:`flyteidl.admin.Project `) - -.. _api_field_flyteidl.admin.Projects.token: - -token - (`string `_) In the case of multiple pages of results, the server-provided token can be used to fetch the next page - in a query. If there are no more results, this value will be empty. - - - - -.. _api_msg_flyteidl.admin.ProjectListRequest: - -flyteidl.admin.ProjectListRequest ---------------------------------- - -`[flyteidl.admin.ProjectListRequest proto] `_ - - -.. code-block:: json - - { - "limit": "...", - "token": "...", - "filters": "...", - "sort_by": "{...}" - } - -.. _api_field_flyteidl.admin.ProjectListRequest.limit: - -limit - (`uint32 `_) Indicates the number of projects to be returned. - - -.. _api_field_flyteidl.admin.ProjectListRequest.token: - -token - (`string `_) In the case of multiple pages of results, this server-provided token can be used to fetch the next page - in a query. - +optional - - -.. _api_field_flyteidl.admin.ProjectListRequest.filters: - -filters - (`string `_) Indicates a list of filters passed as string. - More info on constructing filters : - +optional - - -.. _api_field_flyteidl.admin.ProjectListRequest.sort_by: - -sort_by - (:ref:`flyteidl.admin.Sort `) Sort ordering. - +optional - - - - -.. _api_msg_flyteidl.admin.ProjectRegisterRequest: - -flyteidl.admin.ProjectRegisterRequest -------------------------------------- - -`[flyteidl.admin.ProjectRegisterRequest proto] `_ - - -.. code-block:: json - - { - "project": "{...}" - } - -.. _api_field_flyteidl.admin.ProjectRegisterRequest.project: - -project - (:ref:`flyteidl.admin.Project `) - - - -.. _api_msg_flyteidl.admin.ProjectRegisterResponse: - -flyteidl.admin.ProjectRegisterResponse --------------------------------------- - -`[flyteidl.admin.ProjectRegisterResponse proto] `_ - - -.. code-block:: json - - {} - - - - -.. _api_msg_flyteidl.admin.ProjectUpdateResponse: - -flyteidl.admin.ProjectUpdateResponse ------------------------------------- - -`[flyteidl.admin.ProjectUpdateResponse proto] `_ - - -.. code-block:: json - - {} - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/admin/project_domain_attributes.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/admin/project_domain_attributes.proto.rst deleted file mode 100644 index d2d2bde7d7..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/admin/project_domain_attributes.proto.rst +++ /dev/null @@ -1,184 +0,0 @@ -.. _api_file_flyteidl/admin/project_domain_attributes.proto: - -project_domain_attributes.proto -============================================== - -.. _api_msg_flyteidl.admin.ProjectDomainAttributes: - -flyteidl.admin.ProjectDomainAttributes --------------------------------------- - -`[flyteidl.admin.ProjectDomainAttributes proto] `_ - - -.. code-block:: json - - { - "project": "...", - "domain": "...", - "matching_attributes": "{...}" - } - -.. _api_field_flyteidl.admin.ProjectDomainAttributes.project: - -project - (`string `_) Unique project id for which this set of attributes will be applied. - - -.. _api_field_flyteidl.admin.ProjectDomainAttributes.domain: - -domain - (`string `_) Unique domain id for which this set of attributes will be applied. - - -.. _api_field_flyteidl.admin.ProjectDomainAttributes.matching_attributes: - -matching_attributes - (:ref:`flyteidl.admin.MatchingAttributes `) - - - -.. _api_msg_flyteidl.admin.ProjectDomainAttributesUpdateRequest: - -flyteidl.admin.ProjectDomainAttributesUpdateRequest ---------------------------------------------------- - -`[flyteidl.admin.ProjectDomainAttributesUpdateRequest proto] `_ - -Sets custom attributes for a project-domain combination. - -.. code-block:: json - - { - "attributes": "{...}" - } - -.. _api_field_flyteidl.admin.ProjectDomainAttributesUpdateRequest.attributes: - -attributes - (:ref:`flyteidl.admin.ProjectDomainAttributes `) - - - -.. _api_msg_flyteidl.admin.ProjectDomainAttributesUpdateResponse: - -flyteidl.admin.ProjectDomainAttributesUpdateResponse ----------------------------------------------------- - -`[flyteidl.admin.ProjectDomainAttributesUpdateResponse proto] `_ - -Purposefully empty, may be populated in the future. - -.. code-block:: json - - {} - - - - -.. _api_msg_flyteidl.admin.ProjectDomainAttributesGetRequest: - -flyteidl.admin.ProjectDomainAttributesGetRequest ------------------------------------------------- - -`[flyteidl.admin.ProjectDomainAttributesGetRequest proto] `_ - - -.. code-block:: json - - { - "project": "...", - "domain": "...", - "resource_type": "..." - } - -.. _api_field_flyteidl.admin.ProjectDomainAttributesGetRequest.project: - -project - (`string `_) Unique project id which this set of attributes references. - - -.. _api_field_flyteidl.admin.ProjectDomainAttributesGetRequest.domain: - -domain - (`string `_) Unique domain id which this set of attributes references. - - -.. _api_field_flyteidl.admin.ProjectDomainAttributesGetRequest.resource_type: - -resource_type - (:ref:`flyteidl.admin.MatchableResource `) - - - -.. _api_msg_flyteidl.admin.ProjectDomainAttributesGetResponse: - -flyteidl.admin.ProjectDomainAttributesGetResponse -------------------------------------------------- - -`[flyteidl.admin.ProjectDomainAttributesGetResponse proto] `_ - - -.. code-block:: json - - { - "attributes": "{...}" - } - -.. _api_field_flyteidl.admin.ProjectDomainAttributesGetResponse.attributes: - -attributes - (:ref:`flyteidl.admin.ProjectDomainAttributes `) - - - -.. _api_msg_flyteidl.admin.ProjectDomainAttributesDeleteRequest: - -flyteidl.admin.ProjectDomainAttributesDeleteRequest ---------------------------------------------------- - -`[flyteidl.admin.ProjectDomainAttributesDeleteRequest proto] `_ - - -.. code-block:: json - - { - "project": "...", - "domain": "...", - "resource_type": "..." - } - -.. _api_field_flyteidl.admin.ProjectDomainAttributesDeleteRequest.project: - -project - (`string `_) Unique project id which this set of attributes references. - - -.. _api_field_flyteidl.admin.ProjectDomainAttributesDeleteRequest.domain: - -domain - (`string `_) Unique domain id which this set of attributes references. - - -.. _api_field_flyteidl.admin.ProjectDomainAttributesDeleteRequest.resource_type: - -resource_type - (:ref:`flyteidl.admin.MatchableResource `) - - - -.. _api_msg_flyteidl.admin.ProjectDomainAttributesDeleteResponse: - -flyteidl.admin.ProjectDomainAttributesDeleteResponse ----------------------------------------------------- - -`[flyteidl.admin.ProjectDomainAttributesDeleteResponse proto] `_ - -Purposefully empty, may be populated in the future. - -.. code-block:: json - - {} - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/admin/schedule.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/admin/schedule.proto.rst deleted file mode 100644 index 24ec3b4061..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/admin/schedule.proto.rst +++ /dev/null @@ -1,140 +0,0 @@ -.. _api_file_flyteidl/admin/schedule.proto: - -schedule.proto -============================= - -.. _api_msg_flyteidl.admin.FixedRate: - -flyteidl.admin.FixedRate ------------------------- - -`[flyteidl.admin.FixedRate proto] `_ - -Option for schedules run at a certain frequency, e.g. every 2 minutes. - -.. code-block:: json - - { - "value": "...", - "unit": "..." - } - -.. _api_field_flyteidl.admin.FixedRate.value: - -value - (`uint32 `_) - -.. _api_field_flyteidl.admin.FixedRate.unit: - -unit - (:ref:`flyteidl.admin.FixedRateUnit `) - - - -.. _api_msg_flyteidl.admin.CronSchedule: - -flyteidl.admin.CronSchedule ---------------------------- - -`[flyteidl.admin.CronSchedule proto] `_ - - -.. code-block:: json - - { - "schedule": "...", - "offset": "..." - } - -.. _api_field_flyteidl.admin.CronSchedule.schedule: - -schedule - (`string `_) Standard/default cron implementation as described by https://en.wikipedia.org/wiki/Cron#CRON_expression; - Also supports nonstandard predefined scheduling definitions - as described by https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions - except @reboot - - -.. _api_field_flyteidl.admin.CronSchedule.offset: - -offset - (`string `_) ISO 8601 duration as described by https://en.wikipedia.org/wiki/ISO_8601#Durations - - - - -.. _api_msg_flyteidl.admin.Schedule: - -flyteidl.admin.Schedule ------------------------ - -`[flyteidl.admin.Schedule proto] `_ - -Defines complete set of information required to trigger an execution on a schedule. - -.. code-block:: json - - { - "cron_expression": "...", - "rate": "{...}", - "cron_schedule": "{...}", - "kickoff_time_input_arg": "..." - } - -.. _api_field_flyteidl.admin.Schedule.cron_expression: - -cron_expression - (`string `_) Uses AWS syntax: "Minutes Hours Day-of-month Month Day-of-week Year" - e.g. for a schedule that runs every 15 minutes: "0/15 * * * ? *" - - - - Only one of :ref:`cron_expression `, :ref:`rate `, :ref:`cron_schedule ` may be set. - -.. _api_field_flyteidl.admin.Schedule.rate: - -rate - (:ref:`flyteidl.admin.FixedRate `) - - - Only one of :ref:`cron_expression `, :ref:`rate `, :ref:`cron_schedule ` may be set. - -.. _api_field_flyteidl.admin.Schedule.cron_schedule: - -cron_schedule - (:ref:`flyteidl.admin.CronSchedule `) - - - Only one of :ref:`cron_expression `, :ref:`rate `, :ref:`cron_schedule ` may be set. - -.. _api_field_flyteidl.admin.Schedule.kickoff_time_input_arg: - -kickoff_time_input_arg - (`string `_) Name of the input variable that the kickoff time will be supplied to when the workflow is kicked off. - - - -.. _api_enum_flyteidl.admin.FixedRateUnit: - -Enum flyteidl.admin.FixedRateUnit ---------------------------------- - -`[flyteidl.admin.FixedRateUnit proto] `_ - -Represents a frequency at which to run a schedule. - -.. _api_enum_value_flyteidl.admin.FixedRateUnit.MINUTE: - -MINUTE - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.admin.FixedRateUnit.HOUR: - -HOUR - ⁣ - -.. _api_enum_value_flyteidl.admin.FixedRateUnit.DAY: - -DAY - ⁣ - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/admin/task.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/admin/task.proto.rst deleted file mode 100644 index 6ef8c6c232..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/admin/task.proto.rst +++ /dev/null @@ -1,167 +0,0 @@ -.. _api_file_flyteidl/admin/task.proto: - -task.proto -========================= - -.. _api_msg_flyteidl.admin.TaskCreateRequest: - -flyteidl.admin.TaskCreateRequest --------------------------------- - -`[flyteidl.admin.TaskCreateRequest proto] `_ - -Represents a request structure to create a revision of a task. - -.. code-block:: json - - { - "id": "{...}", - "spec": "{...}" - } - -.. _api_field_flyteidl.admin.TaskCreateRequest.id: - -id - (:ref:`flyteidl.core.Identifier `) id represents the unique identifier of the task. - - -.. _api_field_flyteidl.admin.TaskCreateRequest.spec: - -spec - (:ref:`flyteidl.admin.TaskSpec `) Represents the specification for task. - - - - -.. _api_msg_flyteidl.admin.TaskCreateResponse: - -flyteidl.admin.TaskCreateResponse ---------------------------------- - -`[flyteidl.admin.TaskCreateResponse proto] `_ - -Represents a response structure if task creation succeeds. - -.. code-block:: json - - {} - - - - -.. _api_msg_flyteidl.admin.Task: - -flyteidl.admin.Task -------------------- - -`[flyteidl.admin.Task proto] `_ - -Flyte workflows are composed of many ordered tasks. That is small, reusable, self-contained logical blocks -arranged to process workflow inputs and produce a deterministic set of outputs. -Tasks can come in many varieties tuned for specialized behavior. - -.. code-block:: json - - { - "id": "{...}", - "closure": "{...}" - } - -.. _api_field_flyteidl.admin.Task.id: - -id - (:ref:`flyteidl.core.Identifier `) id represents the unique identifier of the task. - - -.. _api_field_flyteidl.admin.Task.closure: - -closure - (:ref:`flyteidl.admin.TaskClosure `) closure encapsulates all the fields that maps to a compiled version of the task. - - - - -.. _api_msg_flyteidl.admin.TaskList: - -flyteidl.admin.TaskList ------------------------ - -`[flyteidl.admin.TaskList proto] `_ - -Represents a list of tasks returned from the admin. - -.. code-block:: json - - { - "tasks": [], - "token": "..." - } - -.. _api_field_flyteidl.admin.TaskList.tasks: - -tasks - (:ref:`flyteidl.admin.Task `) A list of tasks returned based on the request. - - -.. _api_field_flyteidl.admin.TaskList.token: - -token - (`string `_) In the case of multiple pages of results, the server-provided token can be used to fetch the next page - in a query. If there are no more results, this value will be empty. - - - - -.. _api_msg_flyteidl.admin.TaskSpec: - -flyteidl.admin.TaskSpec ------------------------ - -`[flyteidl.admin.TaskSpec proto] `_ - -Represents a structure that encapsulates the user-configured specification of the task. - -.. code-block:: json - - { - "template": "{...}" - } - -.. _api_field_flyteidl.admin.TaskSpec.template: - -template - (:ref:`flyteidl.core.TaskTemplate `) Template of the task that encapsulates all the metadata of the task. - - - - -.. _api_msg_flyteidl.admin.TaskClosure: - -flyteidl.admin.TaskClosure --------------------------- - -`[flyteidl.admin.TaskClosure proto] `_ - -Compute task attributes which include values derived from the TaskSpec, as well as plugin-specific data -and task metadata. - -.. code-block:: json - - { - "compiled_task": "{...}", - "created_at": "{...}" - } - -.. _api_field_flyteidl.admin.TaskClosure.compiled_task: - -compiled_task - (:ref:`flyteidl.core.CompiledTask `) Represents the compiled representation of the task from the specification provided. - - -.. _api_field_flyteidl.admin.TaskClosure.created_at: - -created_at - (:ref:`google.protobuf.Timestamp `) Time at which the task was created. - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/admin/task_execution.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/admin/task_execution.proto.rst deleted file mode 100644 index a90795c505..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/admin/task_execution.proto.rst +++ /dev/null @@ -1,332 +0,0 @@ -.. _api_file_flyteidl/admin/task_execution.proto: - -task_execution.proto -=================================== - -.. _api_msg_flyteidl.admin.TaskExecutionGetRequest: - -flyteidl.admin.TaskExecutionGetRequest --------------------------------------- - -`[flyteidl.admin.TaskExecutionGetRequest proto] `_ - -A message used to fetch a single task execution entity. - -.. code-block:: json - - { - "id": "{...}" - } - -.. _api_field_flyteidl.admin.TaskExecutionGetRequest.id: - -id - (:ref:`flyteidl.core.TaskExecutionIdentifier `) Unique identifier for the task execution. - - - - -.. _api_msg_flyteidl.admin.TaskExecutionListRequest: - -flyteidl.admin.TaskExecutionListRequest ---------------------------------------- - -`[flyteidl.admin.TaskExecutionListRequest proto] `_ - -Represents a request structure to retrieve a list of task execution entities. - -.. code-block:: json - - { - "node_execution_id": "{...}", - "limit": "...", - "token": "...", - "filters": "...", - "sort_by": "{...}" - } - -.. _api_field_flyteidl.admin.TaskExecutionListRequest.node_execution_id: - -node_execution_id - (:ref:`flyteidl.core.NodeExecutionIdentifier `) Indicates the node execution to filter by. - - -.. _api_field_flyteidl.admin.TaskExecutionListRequest.limit: - -limit - (`uint32 `_) Indicates the number of resources to be returned. - - -.. _api_field_flyteidl.admin.TaskExecutionListRequest.token: - -token - (`string `_) In the case of multiple pages of results, the server-provided token can be used to fetch the next page - in a query. - +optional - - -.. _api_field_flyteidl.admin.TaskExecutionListRequest.filters: - -filters - (`string `_) Indicates a list of filters passed as string. - More info on constructing filters : - +optional - - -.. _api_field_flyteidl.admin.TaskExecutionListRequest.sort_by: - -sort_by - (:ref:`flyteidl.admin.Sort `) Sort ordering for returned list. - +optional - - - - -.. _api_msg_flyteidl.admin.TaskExecution: - -flyteidl.admin.TaskExecution ----------------------------- - -`[flyteidl.admin.TaskExecution proto] `_ - -Encapsulates all details for a single task execution entity. -A task execution represents an instantiated task, including all inputs and additional -metadata as well as computed results included state, outputs, and duration-based attributes. - -.. code-block:: json - - { - "id": "{...}", - "input_uri": "...", - "closure": "{...}", - "is_parent": "..." - } - -.. _api_field_flyteidl.admin.TaskExecution.id: - -id - (:ref:`flyteidl.core.TaskExecutionIdentifier `) Unique identifier for the task execution. - - -.. _api_field_flyteidl.admin.TaskExecution.input_uri: - -input_uri - (`string `_) Path to remote data store where input blob is stored. - - -.. _api_field_flyteidl.admin.TaskExecution.closure: - -closure - (:ref:`flyteidl.admin.TaskExecutionClosure `) Task execution details and results. - - -.. _api_field_flyteidl.admin.TaskExecution.is_parent: - -is_parent - (`bool `_) Whether this task spawned nodes. - - - - -.. _api_msg_flyteidl.admin.TaskExecutionList: - -flyteidl.admin.TaskExecutionList --------------------------------- - -`[flyteidl.admin.TaskExecutionList proto] `_ - -Response structure for a query to list of task execution entities. - -.. code-block:: json - - { - "task_executions": [], - "token": "..." - } - -.. _api_field_flyteidl.admin.TaskExecutionList.task_executions: - -task_executions - (:ref:`flyteidl.admin.TaskExecution `) - -.. _api_field_flyteidl.admin.TaskExecutionList.token: - -token - (`string `_) In the case of multiple pages of results, the server-provided token can be used to fetch the next page - in a query. If there are no more results, this value will be empty. - - - - -.. _api_msg_flyteidl.admin.TaskExecutionClosure: - -flyteidl.admin.TaskExecutionClosure ------------------------------------ - -`[flyteidl.admin.TaskExecutionClosure proto] `_ - -Container for task execution details and results. - -.. code-block:: json - - { - "output_uri": "...", - "error": "{...}", - "phase": "...", - "logs": [], - "started_at": "{...}", - "duration": "{...}", - "created_at": "{...}", - "updated_at": "{...}", - "custom_info": "{...}", - "reason": "...", - "task_type": "...", - "metadata": "{...}" - } - -.. _api_field_flyteidl.admin.TaskExecutionClosure.output_uri: - -output_uri - (`string `_) Path to remote data store where output blob is stored if the execution succeeded (and produced outputs). - - - - Only one of :ref:`output_uri `, :ref:`error ` may be set. - -.. _api_field_flyteidl.admin.TaskExecutionClosure.error: - -error - (:ref:`flyteidl.core.ExecutionError `) Error information for the task execution. Populated if the execution failed. - - - - Only one of :ref:`output_uri `, :ref:`error ` may be set. - -.. _api_field_flyteidl.admin.TaskExecutionClosure.phase: - -phase - (:ref:`flyteidl.core.TaskExecution.Phase `) The last recorded phase for this task execution. - - -.. _api_field_flyteidl.admin.TaskExecutionClosure.logs: - -logs - (:ref:`flyteidl.core.TaskLog `) Detailed log information output by the task execution. - - -.. _api_field_flyteidl.admin.TaskExecutionClosure.started_at: - -started_at - (:ref:`google.protobuf.Timestamp `) Time at which the task execution began running. - - -.. _api_field_flyteidl.admin.TaskExecutionClosure.duration: - -duration - (:ref:`google.protobuf.Duration `) The amount of time the task execution spent running. - - -.. _api_field_flyteidl.admin.TaskExecutionClosure.created_at: - -created_at - (:ref:`google.protobuf.Timestamp `) Time at which the task execution was created. - - -.. _api_field_flyteidl.admin.TaskExecutionClosure.updated_at: - -updated_at - (:ref:`google.protobuf.Timestamp `) Time at which the task execution was last updated. - - -.. _api_field_flyteidl.admin.TaskExecutionClosure.custom_info: - -custom_info - (:ref:`google.protobuf.Struct `) Custom data specific to the task plugin. - - -.. _api_field_flyteidl.admin.TaskExecutionClosure.reason: - -reason - (`string `_) If there is an explanation for the most recent phase transition, the reason will capture it. - - -.. _api_field_flyteidl.admin.TaskExecutionClosure.task_type: - -task_type - (`string `_) A predefined yet extensible Task type identifier. - - -.. _api_field_flyteidl.admin.TaskExecutionClosure.metadata: - -metadata - (:ref:`flyteidl.event.TaskExecutionMetadata `) Metadata around how a task was executed. - - - - -.. _api_msg_flyteidl.admin.TaskExecutionGetDataRequest: - -flyteidl.admin.TaskExecutionGetDataRequest ------------------------------------------- - -`[flyteidl.admin.TaskExecutionGetDataRequest proto] `_ - -Request structure to fetch inputs and output urls for a task execution. - -.. code-block:: json - - { - "id": "{...}" - } - -.. _api_field_flyteidl.admin.TaskExecutionGetDataRequest.id: - -id - (:ref:`flyteidl.core.TaskExecutionIdentifier `) The identifier of the task execution for which to fetch inputs and outputs. - - - - -.. _api_msg_flyteidl.admin.TaskExecutionGetDataResponse: - -flyteidl.admin.TaskExecutionGetDataResponse -------------------------------------------- - -`[flyteidl.admin.TaskExecutionGetDataResponse proto] `_ - -Response structure for TaskExecutionGetDataRequest which contains inputs and outputs for a task execution. - -.. code-block:: json - - { - "inputs": "{...}", - "outputs": "{...}", - "full_inputs": "{...}", - "full_outputs": "{...}" - } - -.. _api_field_flyteidl.admin.TaskExecutionGetDataResponse.inputs: - -inputs - (:ref:`flyteidl.admin.UrlBlob `) Signed url to fetch a core.LiteralMap of task execution inputs. - - -.. _api_field_flyteidl.admin.TaskExecutionGetDataResponse.outputs: - -outputs - (:ref:`flyteidl.admin.UrlBlob `) Signed url to fetch a core.LiteralMap of task execution outputs. - - -.. _api_field_flyteidl.admin.TaskExecutionGetDataResponse.full_inputs: - -full_inputs - (:ref:`flyteidl.core.LiteralMap `) Optional, full_inputs will only be populated if they are under a configured size threshold. - - -.. _api_field_flyteidl.admin.TaskExecutionGetDataResponse.full_outputs: - -full_outputs - (:ref:`flyteidl.core.LiteralMap `) Optional, full_outputs will only be populated if they are under a configured size threshold. - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/admin/version.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/admin/version.proto.rst deleted file mode 100644 index a3aa10d3fd..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/admin/version.proto.rst +++ /dev/null @@ -1,81 +0,0 @@ -.. _api_file_flyteidl/admin/version.proto: - -version.proto -============================ - -.. _api_msg_flyteidl.admin.GetVersionResponse: - -flyteidl.admin.GetVersionResponse ---------------------------------- - -`[flyteidl.admin.GetVersionResponse proto] `_ - -Response for the GetVersion API - -.. code-block:: json - - { - "control_plane_version": "{...}" - } - -.. _api_field_flyteidl.admin.GetVersionResponse.control_plane_version: - -control_plane_version - (:ref:`flyteidl.admin.Version `) The control plane version information. FlyteAdmin and related components - form the control plane of Flyte - - - - -.. _api_msg_flyteidl.admin.Version: - -flyteidl.admin.Version ----------------------- - -`[flyteidl.admin.Version proto] `_ - -Provides Version information for a component - -.. code-block:: json - - { - "Build": "...", - "Version": "...", - "BuildTime": "..." - } - -.. _api_field_flyteidl.admin.Version.Build: - -Build - (`string `_) Specifies the GIT sha of the build - - -.. _api_field_flyteidl.admin.Version.Version: - -Version - (`string `_) Version for the build, should follow a semver - - -.. _api_field_flyteidl.admin.Version.BuildTime: - -BuildTime - (`string `_) Build timestamp - - - - -.. _api_msg_flyteidl.admin.GetVersionRequest: - -flyteidl.admin.GetVersionRequest --------------------------------- - -`[flyteidl.admin.GetVersionRequest proto] `_ - -Empty request for GetVersion - -.. code-block:: json - - {} - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/admin/workflow.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/admin/workflow.proto.rst deleted file mode 100644 index 789bad838c..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/admin/workflow.proto.rst +++ /dev/null @@ -1,174 +0,0 @@ -.. _api_file_flyteidl/admin/workflow.proto: - -workflow.proto -============================= - -.. _api_msg_flyteidl.admin.WorkflowCreateRequest: - -flyteidl.admin.WorkflowCreateRequest ------------------------------------- - -`[flyteidl.admin.WorkflowCreateRequest proto] `_ - -Represents a request structure to create a revision of a workflow. - -.. code-block:: json - - { - "id": "{...}", - "spec": "{...}" - } - -.. _api_field_flyteidl.admin.WorkflowCreateRequest.id: - -id - (:ref:`flyteidl.core.Identifier `) id represents the unique identifier of the workflow. - - -.. _api_field_flyteidl.admin.WorkflowCreateRequest.spec: - -spec - (:ref:`flyteidl.admin.WorkflowSpec `) Represents the specification for workflow. - - - - -.. _api_msg_flyteidl.admin.WorkflowCreateResponse: - -flyteidl.admin.WorkflowCreateResponse -------------------------------------- - -`[flyteidl.admin.WorkflowCreateResponse proto] `_ - - -.. code-block:: json - - {} - - - - -.. _api_msg_flyteidl.admin.Workflow: - -flyteidl.admin.Workflow ------------------------ - -`[flyteidl.admin.Workflow proto] `_ - -Represents the workflow structure stored in the Admin -A workflow is created by ordering tasks and associating outputs to inputs -in order to produce a directed-acyclic execution graph. - -.. code-block:: json - - { - "id": "{...}", - "closure": "{...}" - } - -.. _api_field_flyteidl.admin.Workflow.id: - -id - (:ref:`flyteidl.core.Identifier `) id represents the unique identifier of the workflow. - - -.. _api_field_flyteidl.admin.Workflow.closure: - -closure - (:ref:`flyteidl.admin.WorkflowClosure `) closure encapsulates all the fields that maps to a compiled version of the workflow. - - - - -.. _api_msg_flyteidl.admin.WorkflowList: - -flyteidl.admin.WorkflowList ---------------------------- - -`[flyteidl.admin.WorkflowList proto] `_ - -Represents a list of workflows returned from the admin. - -.. code-block:: json - - { - "workflows": [], - "token": "..." - } - -.. _api_field_flyteidl.admin.WorkflowList.workflows: - -workflows - (:ref:`flyteidl.admin.Workflow `) A list of workflows returned based on the request. - - -.. _api_field_flyteidl.admin.WorkflowList.token: - -token - (`string `_) In the case of multiple pages of results, the server-provided token can be used to fetch the next page - in a query. If there are no more results, this value will be empty. - - - - -.. _api_msg_flyteidl.admin.WorkflowSpec: - -flyteidl.admin.WorkflowSpec ---------------------------- - -`[flyteidl.admin.WorkflowSpec proto] `_ - -Represents a structure that encapsulates the specification of the workflow. - -.. code-block:: json - - { - "template": "{...}", - "sub_workflows": [] - } - -.. _api_field_flyteidl.admin.WorkflowSpec.template: - -template - (:ref:`flyteidl.core.WorkflowTemplate `) Template of the task that encapsulates all the metadata of the workflow. - - -.. _api_field_flyteidl.admin.WorkflowSpec.sub_workflows: - -sub_workflows - (:ref:`flyteidl.core.WorkflowTemplate `) Workflows that are embedded into other workflows need to be passed alongside the parent workflow to the - propeller compiler (since the compiler doesn't have any knowledge of other workflows - ie, it doesn't reach out - to Admin to see other registered workflows). In fact, subworkflows do not even need to be registered. - - - - -.. _api_msg_flyteidl.admin.WorkflowClosure: - -flyteidl.admin.WorkflowClosure ------------------------------- - -`[flyteidl.admin.WorkflowClosure proto] `_ - -A container holding the compiled workflow produced from the WorkflowSpec and additional metadata. - -.. code-block:: json - - { - "compiled_workflow": "{...}", - "created_at": "{...}" - } - -.. _api_field_flyteidl.admin.WorkflowClosure.compiled_workflow: - -compiled_workflow - (:ref:`flyteidl.core.CompiledWorkflowClosure `) Represents the compiled representation of the workflow from the specification provided. - - -.. _api_field_flyteidl.admin.WorkflowClosure.created_at: - -created_at - (:ref:`google.protobuf.Timestamp `) Time at which the workflow was created. - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/admin/workflow_attributes.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/admin/workflow_attributes.proto.rst deleted file mode 100644 index 9ebc9cf9df..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/admin/workflow_attributes.proto.rst +++ /dev/null @@ -1,205 +0,0 @@ -.. _api_file_flyteidl/admin/workflow_attributes.proto: - -workflow_attributes.proto -======================================== - -.. _api_msg_flyteidl.admin.WorkflowAttributes: - -flyteidl.admin.WorkflowAttributes ---------------------------------- - -`[flyteidl.admin.WorkflowAttributes proto] `_ - - -.. code-block:: json - - { - "project": "...", - "domain": "...", - "workflow": "...", - "matching_attributes": "{...}" - } - -.. _api_field_flyteidl.admin.WorkflowAttributes.project: - -project - (`string `_) Unique project id for which this set of attributes will be applied. - - -.. _api_field_flyteidl.admin.WorkflowAttributes.domain: - -domain - (`string `_) Unique domain id for which this set of attributes will be applied. - - -.. _api_field_flyteidl.admin.WorkflowAttributes.workflow: - -workflow - (`string `_) Workflow name for which this set of attributes will be applied. - - -.. _api_field_flyteidl.admin.WorkflowAttributes.matching_attributes: - -matching_attributes - (:ref:`flyteidl.admin.MatchingAttributes `) - - - -.. _api_msg_flyteidl.admin.WorkflowAttributesUpdateRequest: - -flyteidl.admin.WorkflowAttributesUpdateRequest ----------------------------------------------- - -`[flyteidl.admin.WorkflowAttributesUpdateRequest proto] `_ - -Sets custom attributes for a project, domain and workflow combination. - -.. code-block:: json - - { - "attributes": "{...}" - } - -.. _api_field_flyteidl.admin.WorkflowAttributesUpdateRequest.attributes: - -attributes - (:ref:`flyteidl.admin.WorkflowAttributes `) - - - -.. _api_msg_flyteidl.admin.WorkflowAttributesUpdateResponse: - -flyteidl.admin.WorkflowAttributesUpdateResponse ------------------------------------------------ - -`[flyteidl.admin.WorkflowAttributesUpdateResponse proto] `_ - -Purposefully empty, may be populated in the future. - -.. code-block:: json - - {} - - - - -.. _api_msg_flyteidl.admin.WorkflowAttributesGetRequest: - -flyteidl.admin.WorkflowAttributesGetRequest -------------------------------------------- - -`[flyteidl.admin.WorkflowAttributesGetRequest proto] `_ - - -.. code-block:: json - - { - "project": "...", - "domain": "...", - "workflow": "...", - "resource_type": "..." - } - -.. _api_field_flyteidl.admin.WorkflowAttributesGetRequest.project: - -project - (`string `_) Unique project id which this set of attributes references. - - -.. _api_field_flyteidl.admin.WorkflowAttributesGetRequest.domain: - -domain - (`string `_) Unique domain id which this set of attributes references. - - -.. _api_field_flyteidl.admin.WorkflowAttributesGetRequest.workflow: - -workflow - (`string `_) Workflow name which this set of attributes references. - - -.. _api_field_flyteidl.admin.WorkflowAttributesGetRequest.resource_type: - -resource_type - (:ref:`flyteidl.admin.MatchableResource `) - - - -.. _api_msg_flyteidl.admin.WorkflowAttributesGetResponse: - -flyteidl.admin.WorkflowAttributesGetResponse --------------------------------------------- - -`[flyteidl.admin.WorkflowAttributesGetResponse proto] `_ - - -.. code-block:: json - - { - "attributes": "{...}" - } - -.. _api_field_flyteidl.admin.WorkflowAttributesGetResponse.attributes: - -attributes - (:ref:`flyteidl.admin.WorkflowAttributes `) - - - -.. _api_msg_flyteidl.admin.WorkflowAttributesDeleteRequest: - -flyteidl.admin.WorkflowAttributesDeleteRequest ----------------------------------------------- - -`[flyteidl.admin.WorkflowAttributesDeleteRequest proto] `_ - - -.. code-block:: json - - { - "project": "...", - "domain": "...", - "workflow": "...", - "resource_type": "..." - } - -.. _api_field_flyteidl.admin.WorkflowAttributesDeleteRequest.project: - -project - (`string `_) Unique project id which this set of attributes references. - - -.. _api_field_flyteidl.admin.WorkflowAttributesDeleteRequest.domain: - -domain - (`string `_) Unique domain id which this set of attributes references. - - -.. _api_field_flyteidl.admin.WorkflowAttributesDeleteRequest.workflow: - -workflow - (`string `_) Workflow name which this set of attributes references. - - -.. _api_field_flyteidl.admin.WorkflowAttributesDeleteRequest.resource_type: - -resource_type - (:ref:`flyteidl.admin.MatchableResource `) - - - -.. _api_msg_flyteidl.admin.WorkflowAttributesDeleteResponse: - -flyteidl.admin.WorkflowAttributesDeleteResponse ------------------------------------------------ - -`[flyteidl.admin.WorkflowAttributesDeleteResponse proto] `_ - -Purposefully empty, may be populated in the future. - -.. code-block:: json - - {} - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/core/catalog.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/core/catalog.proto.rst deleted file mode 100644 index 6fdfde2253..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/core/catalog.proto.rst +++ /dev/null @@ -1,117 +0,0 @@ -.. _api_file_flyteidl/core/catalog.proto: - -catalog.proto -=========================== - -.. _api_msg_flyteidl.core.CatalogArtifactTag: - -flyteidl.core.CatalogArtifactTag --------------------------------- - -`[flyteidl.core.CatalogArtifactTag proto] `_ - - -.. code-block:: json - - { - "artifact_id": "...", - "name": "..." - } - -.. _api_field_flyteidl.core.CatalogArtifactTag.artifact_id: - -artifact_id - (`string `_) Artifact ID is generated name - - -.. _api_field_flyteidl.core.CatalogArtifactTag.name: - -name - (`string `_) Flyte computes the tag automatically, as the hash of the values - - - - -.. _api_msg_flyteidl.core.CatalogMetadata: - -flyteidl.core.CatalogMetadata ------------------------------ - -`[flyteidl.core.CatalogMetadata proto] `_ - -Catalog artifact information with specific metadata - -.. code-block:: json - - { - "dataset_id": "{...}", - "artifact_tag": "{...}", - "source_task_execution": "{...}" - } - -.. _api_field_flyteidl.core.CatalogMetadata.dataset_id: - -dataset_id - (:ref:`flyteidl.core.Identifier `) Dataset ID in the catalog - - -.. _api_field_flyteidl.core.CatalogMetadata.artifact_tag: - -artifact_tag - (:ref:`flyteidl.core.CatalogArtifactTag `) Artifact tag in the catalog - - -.. _api_field_flyteidl.core.CatalogMetadata.source_task_execution: - -source_task_execution - (:ref:`flyteidl.core.TaskExecutionIdentifier `) Today we only support TaskExecutionIdentifier as a source, as catalog caching only works for task executions - - Optional: Source Execution identifier, if this dataset was generated by another execution in Flyte. This is a one-of field and will depend on the caching context - - - -.. _api_enum_flyteidl.core.CatalogCacheStatus: - -Enum flyteidl.core.CatalogCacheStatus -------------------------------------- - -`[flyteidl.core.CatalogCacheStatus proto] `_ - -Indicates the status of CatalogCaching. The reason why this is not embeded in TaskNodeMetadata is, that we may use for other types of nodes as well in the future - -.. _api_enum_value_flyteidl.core.CatalogCacheStatus.CACHE_DISABLED: - -CACHE_DISABLED - *(DEFAULT)* ⁣Used to indicate that caching was disabled - - -.. _api_enum_value_flyteidl.core.CatalogCacheStatus.CACHE_MISS: - -CACHE_MISS - ⁣Used to indicate that the cache lookup resulted in no matches - - -.. _api_enum_value_flyteidl.core.CatalogCacheStatus.CACHE_HIT: - -CACHE_HIT - ⁣used to indicate that the associated artifact was a result of a previous execution - - -.. _api_enum_value_flyteidl.core.CatalogCacheStatus.CACHE_POPULATED: - -CACHE_POPULATED - ⁣used to indicate that the resultant artifact was added to the cache - - -.. _api_enum_value_flyteidl.core.CatalogCacheStatus.CACHE_LOOKUP_FAILURE: - -CACHE_LOOKUP_FAILURE - ⁣Used to indicate that cache lookup failed because of an error - - -.. _api_enum_value_flyteidl.core.CatalogCacheStatus.CACHE_PUT_FAILURE: - -CACHE_PUT_FAILURE - ⁣Used to indicate that cache lookup failed because of an error - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/core/compiler.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/core/compiler.proto.rst deleted file mode 100644 index 4562e25912..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/core/compiler.proto.rst +++ /dev/null @@ -1,154 +0,0 @@ -.. _api_file_flyteidl/core/compiler.proto: - -compiler.proto -============================ - -.. _api_msg_flyteidl.core.ConnectionSet: - -flyteidl.core.ConnectionSet ---------------------------- - -`[flyteidl.core.ConnectionSet proto] `_ - -Adjacency list for the workflow. This is created as part of the compilation process. Every process after the compilation -step uses this created ConnectionSet - -.. code-block:: json - - { - "downstream": "{...}", - "upstream": "{...}" - } - -.. _api_field_flyteidl.core.ConnectionSet.downstream: - -downstream - (map<`string `_, :ref:`flyteidl.core.ConnectionSet.IdList `>) A list of all the node ids that are downstream from a given node id - - -.. _api_field_flyteidl.core.ConnectionSet.upstream: - -upstream - (map<`string `_, :ref:`flyteidl.core.ConnectionSet.IdList `>) A list of all the node ids, that are upstream of this node id - - -.. _api_msg_flyteidl.core.ConnectionSet.IdList: - -flyteidl.core.ConnectionSet.IdList ----------------------------------- - -`[flyteidl.core.ConnectionSet.IdList proto] `_ - - -.. code-block:: json - - { - "ids": [] - } - -.. _api_field_flyteidl.core.ConnectionSet.IdList.ids: - -ids - (`string `_) - - - - - - -.. _api_msg_flyteidl.core.CompiledWorkflow: - -flyteidl.core.CompiledWorkflow ------------------------------- - -`[flyteidl.core.CompiledWorkflow proto] `_ - -Output of the compilation Step. This object represents one workflow. We store more metadata at this layer - -.. code-block:: json - - { - "template": "{...}", - "connections": "{...}" - } - -.. _api_field_flyteidl.core.CompiledWorkflow.template: - -template - (:ref:`flyteidl.core.WorkflowTemplate `) Completely contained Workflow Template - - -.. _api_field_flyteidl.core.CompiledWorkflow.connections: - -connections - (:ref:`flyteidl.core.ConnectionSet `) For internal use only! This field is used by the system and must not be filled in. Any values set will be ignored. - - - - -.. _api_msg_flyteidl.core.CompiledTask: - -flyteidl.core.CompiledTask --------------------------- - -`[flyteidl.core.CompiledTask proto] `_ - -Output of the Compilation step. This object represent one Task. We store more metadata at this layer - -.. code-block:: json - - { - "template": "{...}" - } - -.. _api_field_flyteidl.core.CompiledTask.template: - -template - (:ref:`flyteidl.core.TaskTemplate `) Completely contained TaskTemplate - - - - -.. _api_msg_flyteidl.core.CompiledWorkflowClosure: - -flyteidl.core.CompiledWorkflowClosure -------------------------------------- - -`[flyteidl.core.CompiledWorkflowClosure proto] `_ - -A Compiled Workflow Closure contains all the information required to start a new execution, or to visualize a workflow -and its details. The CompiledWorkflowClosure should always contain a primary workflow, that is the main workflow that -will being the execution. All subworkflows are denormalized. WorkflowNodes refer to the workflow identifiers of -compiled subworkflows. - -.. code-block:: json - - { - "primary": "{...}", - "sub_workflows": [], - "tasks": [] - } - -.. _api_field_flyteidl.core.CompiledWorkflowClosure.primary: - -primary - (:ref:`flyteidl.core.CompiledWorkflow `) required - - -.. _api_field_flyteidl.core.CompiledWorkflowClosure.sub_workflows: - -sub_workflows - (:ref:`flyteidl.core.CompiledWorkflow `) Guaranteed that there will only exist one and only one workflow with a given id, i.e., every sub workflow has a - unique identifier. Also every enclosed subworkflow is used either by a primary workflow or by a subworkflow - as an inlined workflow - optional - - -.. _api_field_flyteidl.core.CompiledWorkflowClosure.tasks: - -tasks - (:ref:`flyteidl.core.CompiledTask `) Guaranteed that there will only exist one and only one task with a given id, i.e., every task has a unique id - required (atleast 1) - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/core/condition.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/core/condition.proto.rst deleted file mode 100644 index cad698941c..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/core/condition.proto.rst +++ /dev/null @@ -1,206 +0,0 @@ -.. _api_file_flyteidl/core/condition.proto: - -condition.proto -============================= - -.. _api_msg_flyteidl.core.ComparisonExpression: - -flyteidl.core.ComparisonExpression ----------------------------------- - -`[flyteidl.core.ComparisonExpression proto] `_ - -Defines a 2-level tree where the root is a comparison operator and Operands are primitives or known variables. -Each expression results in a boolean result. - -.. code-block:: json - - { - "operator": "...", - "left_value": "{...}", - "right_value": "{...}" - } - -.. _api_field_flyteidl.core.ComparisonExpression.operator: - -operator - (:ref:`flyteidl.core.ComparisonExpression.Operator `) - -.. _api_field_flyteidl.core.ComparisonExpression.left_value: - -left_value - (:ref:`flyteidl.core.Operand `) - -.. _api_field_flyteidl.core.ComparisonExpression.right_value: - -right_value - (:ref:`flyteidl.core.Operand `) - - -.. _api_enum_flyteidl.core.ComparisonExpression.Operator: - -Enum flyteidl.core.ComparisonExpression.Operator ------------------------------------------------- - -`[flyteidl.core.ComparisonExpression.Operator proto] `_ - -Binary Operator for each expression - -.. _api_enum_value_flyteidl.core.ComparisonExpression.Operator.EQ: - -EQ - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.core.ComparisonExpression.Operator.NEQ: - -NEQ - ⁣ - -.. _api_enum_value_flyteidl.core.ComparisonExpression.Operator.GT: - -GT - ⁣Greater Than - - -.. _api_enum_value_flyteidl.core.ComparisonExpression.Operator.GTE: - -GTE - ⁣ - -.. _api_enum_value_flyteidl.core.ComparisonExpression.Operator.LT: - -LT - ⁣Less Than - - -.. _api_enum_value_flyteidl.core.ComparisonExpression.Operator.LTE: - -LTE - ⁣ - - -.. _api_msg_flyteidl.core.Operand: - -flyteidl.core.Operand ---------------------- - -`[flyteidl.core.Operand proto] `_ - -Defines an operand to a comparison expression. - -.. code-block:: json - - { - "primitive": "{...}", - "var": "..." - } - -.. _api_field_flyteidl.core.Operand.primitive: - -primitive - (:ref:`flyteidl.core.Primitive `) Can be a constant - - - - Only one of :ref:`primitive `, :ref:`var ` may be set. - -.. _api_field_flyteidl.core.Operand.var: - -var - (`string `_) Or one of this node's input variables - - - - Only one of :ref:`primitive `, :ref:`var ` may be set. - - - -.. _api_msg_flyteidl.core.BooleanExpression: - -flyteidl.core.BooleanExpression -------------------------------- - -`[flyteidl.core.BooleanExpression proto] `_ - -Defines a boolean expression tree. It can be a simple or a conjunction expression. -Multiple expressions can be combined using a conjunction or a disjunction to result in a final boolean result. - -.. code-block:: json - - { - "conjunction": "{...}", - "comparison": "{...}" - } - -.. _api_field_flyteidl.core.BooleanExpression.conjunction: - -conjunction - (:ref:`flyteidl.core.ConjunctionExpression `) - - - Only one of :ref:`conjunction `, :ref:`comparison ` may be set. - -.. _api_field_flyteidl.core.BooleanExpression.comparison: - -comparison - (:ref:`flyteidl.core.ComparisonExpression `) - - - Only one of :ref:`conjunction `, :ref:`comparison ` may be set. - - - -.. _api_msg_flyteidl.core.ConjunctionExpression: - -flyteidl.core.ConjunctionExpression ------------------------------------ - -`[flyteidl.core.ConjunctionExpression proto] `_ - -Defines a conjunction expression of two boolean expressions. - -.. code-block:: json - - { - "operator": "...", - "left_expression": "{...}", - "right_expression": "{...}" - } - -.. _api_field_flyteidl.core.ConjunctionExpression.operator: - -operator - (:ref:`flyteidl.core.ConjunctionExpression.LogicalOperator `) - -.. _api_field_flyteidl.core.ConjunctionExpression.left_expression: - -left_expression - (:ref:`flyteidl.core.BooleanExpression `) - -.. _api_field_flyteidl.core.ConjunctionExpression.right_expression: - -right_expression - (:ref:`flyteidl.core.BooleanExpression `) - - -.. _api_enum_flyteidl.core.ConjunctionExpression.LogicalOperator: - -Enum flyteidl.core.ConjunctionExpression.LogicalOperator --------------------------------------------------------- - -`[flyteidl.core.ConjunctionExpression.LogicalOperator proto] `_ - -Nested conditions. They can be conjoined using AND / OR -Order of evaluation is not important as the operators are Commutative - -.. _api_enum_value_flyteidl.core.ConjunctionExpression.LogicalOperator.AND: - -AND - *(DEFAULT)* ⁣Conjunction - - -.. _api_enum_value_flyteidl.core.ConjunctionExpression.LogicalOperator.OR: - -OR - ⁣ - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/core/dynamic_job.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/core/dynamic_job.proto.rst deleted file mode 100644 index 6bb0f110b5..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/core/dynamic_job.proto.rst +++ /dev/null @@ -1,60 +0,0 @@ -.. _api_file_flyteidl/core/dynamic_job.proto: - -dynamic_job.proto -=============================== - -.. _api_msg_flyteidl.core.DynamicJobSpec: - -flyteidl.core.DynamicJobSpec ----------------------------- - -`[flyteidl.core.DynamicJobSpec proto] `_ - -Describes a set of tasks to execute and how the final outputs are produced. - -.. code-block:: json - - { - "nodes": [], - "min_successes": "...", - "outputs": [], - "tasks": [], - "subworkflows": [] - } - -.. _api_field_flyteidl.core.DynamicJobSpec.nodes: - -nodes - (:ref:`flyteidl.core.Node `) A collection of nodes to execute. - - -.. _api_field_flyteidl.core.DynamicJobSpec.min_successes: - -min_successes - (`int64 `_) An absolute number of successful completions of nodes required to mark this job as succeeded. As soon as this - criteria is met, the dynamic job will be marked as successful and outputs will be computed. If this number - becomes impossible to reach (e.g. number of currently running tasks + number of already succeeded tasks < - min_successes) the task will be aborted immediately and marked as failed. The default value of this field, if not - specified, is the count of nodes repeated field. - - -.. _api_field_flyteidl.core.DynamicJobSpec.outputs: - -outputs - (:ref:`flyteidl.core.Binding `) Describes how to bind the final output of the dynamic job from the outputs of executed nodes. The referenced ids - in bindings should have the generated id for the subtask. - - -.. _api_field_flyteidl.core.DynamicJobSpec.tasks: - -tasks - (:ref:`flyteidl.core.TaskTemplate `) [Optional] A complete list of task specs referenced in nodes. - - -.. _api_field_flyteidl.core.DynamicJobSpec.subworkflows: - -subworkflows - (:ref:`flyteidl.core.WorkflowTemplate `) [Optional] A complete list of task specs referenced in nodes. - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/core/errors.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/core/errors.proto.rst deleted file mode 100644 index 988ea2f3dd..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/core/errors.proto.rst +++ /dev/null @@ -1,92 +0,0 @@ -.. _api_file_flyteidl/core/errors.proto: - -errors.proto -========================== - -.. _api_msg_flyteidl.core.ContainerError: - -flyteidl.core.ContainerError ----------------------------- - -`[flyteidl.core.ContainerError proto] `_ - -Error message to propagate detailed errors from container executions to the execution -engine. - -.. code-block:: json - - { - "code": "...", - "message": "...", - "kind": "...", - "origin": "..." - } - -.. _api_field_flyteidl.core.ContainerError.code: - -code - (`string `_) A simplified code for errors, so that we can provide a glossary of all possible errors. - - -.. _api_field_flyteidl.core.ContainerError.message: - -message - (`string `_) A detailed error message. - - -.. _api_field_flyteidl.core.ContainerError.kind: - -kind - (:ref:`flyteidl.core.ContainerError.Kind `) An abstract error kind for this error. Defaults to Non_Recoverable if not specified. - - -.. _api_field_flyteidl.core.ContainerError.origin: - -origin - (:ref:`flyteidl.core.ExecutionError.ErrorKind `) Defines the origin of the error (system, user, unknown). - - - -.. _api_enum_flyteidl.core.ContainerError.Kind: - -Enum flyteidl.core.ContainerError.Kind --------------------------------------- - -`[flyteidl.core.ContainerError.Kind proto] `_ - -Defines a generic error type that dictates the behavior of the retry strategy. - -.. _api_enum_value_flyteidl.core.ContainerError.Kind.NON_RECOVERABLE: - -NON_RECOVERABLE - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.core.ContainerError.Kind.RECOVERABLE: - -RECOVERABLE - ⁣ - - -.. _api_msg_flyteidl.core.ErrorDocument: - -flyteidl.core.ErrorDocument ---------------------------- - -`[flyteidl.core.ErrorDocument proto] `_ - -Defines the errors.pb file format the container can produce to communicate -failure reasons to the execution engine. - -.. code-block:: json - - { - "error": "{...}" - } - -.. _api_field_flyteidl.core.ErrorDocument.error: - -error - (:ref:`flyteidl.core.ContainerError `) The error raised during execution. - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/core/execution.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/core/execution.proto.rst deleted file mode 100644 index 77d922410b..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/core/execution.proto.rst +++ /dev/null @@ -1,432 +0,0 @@ -.. _api_file_flyteidl/core/execution.proto: - -execution.proto -============================= - -.. _api_msg_flyteidl.core.WorkflowExecution: - -flyteidl.core.WorkflowExecution -------------------------------- - -`[flyteidl.core.WorkflowExecution proto] `_ - -Indicates various phases of Workflow Execution - -.. code-block:: json - - {} - - - -.. _api_enum_flyteidl.core.WorkflowExecution.Phase: - -Enum flyteidl.core.WorkflowExecution.Phase ------------------------------------------- - -`[flyteidl.core.WorkflowExecution.Phase proto] `_ - - -.. _api_enum_value_flyteidl.core.WorkflowExecution.Phase.UNDEFINED: - -UNDEFINED - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.core.WorkflowExecution.Phase.QUEUED: - -QUEUED - ⁣ - -.. _api_enum_value_flyteidl.core.WorkflowExecution.Phase.RUNNING: - -RUNNING - ⁣ - -.. _api_enum_value_flyteidl.core.WorkflowExecution.Phase.SUCCEEDING: - -SUCCEEDING - ⁣ - -.. _api_enum_value_flyteidl.core.WorkflowExecution.Phase.SUCCEEDED: - -SUCCEEDED - ⁣ - -.. _api_enum_value_flyteidl.core.WorkflowExecution.Phase.FAILING: - -FAILING - ⁣ - -.. _api_enum_value_flyteidl.core.WorkflowExecution.Phase.FAILED: - -FAILED - ⁣ - -.. _api_enum_value_flyteidl.core.WorkflowExecution.Phase.ABORTED: - -ABORTED - ⁣ - -.. _api_enum_value_flyteidl.core.WorkflowExecution.Phase.TIMED_OUT: - -TIMED_OUT - ⁣ - - -.. _api_msg_flyteidl.core.NodeExecution: - -flyteidl.core.NodeExecution ---------------------------- - -`[flyteidl.core.NodeExecution proto] `_ - -Indicates various phases of Node Execution - -.. code-block:: json - - {} - - - -.. _api_enum_flyteidl.core.NodeExecution.Phase: - -Enum flyteidl.core.NodeExecution.Phase --------------------------------------- - -`[flyteidl.core.NodeExecution.Phase proto] `_ - - -.. _api_enum_value_flyteidl.core.NodeExecution.Phase.UNDEFINED: - -UNDEFINED - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.core.NodeExecution.Phase.QUEUED: - -QUEUED - ⁣ - -.. _api_enum_value_flyteidl.core.NodeExecution.Phase.RUNNING: - -RUNNING - ⁣ - -.. _api_enum_value_flyteidl.core.NodeExecution.Phase.SUCCEEDED: - -SUCCEEDED - ⁣ - -.. _api_enum_value_flyteidl.core.NodeExecution.Phase.FAILING: - -FAILING - ⁣ - -.. _api_enum_value_flyteidl.core.NodeExecution.Phase.FAILED: - -FAILED - ⁣ - -.. _api_enum_value_flyteidl.core.NodeExecution.Phase.ABORTED: - -ABORTED - ⁣ - -.. _api_enum_value_flyteidl.core.NodeExecution.Phase.SKIPPED: - -SKIPPED - ⁣ - -.. _api_enum_value_flyteidl.core.NodeExecution.Phase.TIMED_OUT: - -TIMED_OUT - ⁣ - -.. _api_enum_value_flyteidl.core.NodeExecution.Phase.DYNAMIC_RUNNING: - -DYNAMIC_RUNNING - ⁣ - - -.. _api_msg_flyteidl.core.TaskExecution: - -flyteidl.core.TaskExecution ---------------------------- - -`[flyteidl.core.TaskExecution proto] `_ - -Phases that task plugins can go through. Not all phases may be applicable to a specific plugin task, -but this is the cumulative list that customers may want to know about for their task. - -.. code-block:: json - - {} - - - -.. _api_enum_flyteidl.core.TaskExecution.Phase: - -Enum flyteidl.core.TaskExecution.Phase --------------------------------------- - -`[flyteidl.core.TaskExecution.Phase proto] `_ - - -.. _api_enum_value_flyteidl.core.TaskExecution.Phase.UNDEFINED: - -UNDEFINED - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.core.TaskExecution.Phase.QUEUED: - -QUEUED - ⁣ - -.. _api_enum_value_flyteidl.core.TaskExecution.Phase.RUNNING: - -RUNNING - ⁣ - -.. _api_enum_value_flyteidl.core.TaskExecution.Phase.SUCCEEDED: - -SUCCEEDED - ⁣ - -.. _api_enum_value_flyteidl.core.TaskExecution.Phase.ABORTED: - -ABORTED - ⁣ - -.. _api_enum_value_flyteidl.core.TaskExecution.Phase.FAILED: - -FAILED - ⁣ - -.. _api_enum_value_flyteidl.core.TaskExecution.Phase.INITIALIZING: - -INITIALIZING - ⁣To indicate cases where task is initializing, like: ErrImagePull, ContainerCreating, PodInitializing - - -.. _api_enum_value_flyteidl.core.TaskExecution.Phase.WAITING_FOR_RESOURCES: - -WAITING_FOR_RESOURCES - ⁣To address cases, where underlying resource is not available: Backoff error, Resource quota exceeded - - - -.. _api_msg_flyteidl.core.ExecutionError: - -flyteidl.core.ExecutionError ----------------------------- - -`[flyteidl.core.ExecutionError proto] `_ - -Represents the error message from the execution. - -.. code-block:: json - - { - "code": "...", - "message": "...", - "error_uri": "...", - "kind": "..." - } - -.. _api_field_flyteidl.core.ExecutionError.code: - -code - (`string `_) Error code indicates a grouping of a type of error. - More Info: - - -.. _api_field_flyteidl.core.ExecutionError.message: - -message - (`string `_) Detailed description of the error - including stack trace. - - -.. _api_field_flyteidl.core.ExecutionError.error_uri: - -error_uri - (`string `_) Full error contents accessible via a URI - - -.. _api_field_flyteidl.core.ExecutionError.kind: - -kind - (:ref:`flyteidl.core.ExecutionError.ErrorKind `) - - -.. _api_enum_flyteidl.core.ExecutionError.ErrorKind: - -Enum flyteidl.core.ExecutionError.ErrorKind -------------------------------------------- - -`[flyteidl.core.ExecutionError.ErrorKind proto] `_ - -Error type: System or User - -.. _api_enum_value_flyteidl.core.ExecutionError.ErrorKind.UNKNOWN: - -UNKNOWN - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.core.ExecutionError.ErrorKind.USER: - -USER - ⁣ - -.. _api_enum_value_flyteidl.core.ExecutionError.ErrorKind.SYSTEM: - -SYSTEM - ⁣ - - -.. _api_msg_flyteidl.core.TaskLog: - -flyteidl.core.TaskLog ---------------------- - -`[flyteidl.core.TaskLog proto] `_ - -Log information for the task that is specific to a log sink -When our log story is flushed out, we may have more metadata here like log link expiry - -.. code-block:: json - - { - "uri": "...", - "name": "...", - "message_format": "...", - "ttl": "{...}" - } - -.. _api_field_flyteidl.core.TaskLog.uri: - -uri - (`string `_) - -.. _api_field_flyteidl.core.TaskLog.name: - -name - (`string `_) - -.. _api_field_flyteidl.core.TaskLog.message_format: - -message_format - (:ref:`flyteidl.core.TaskLog.MessageFormat `) - -.. _api_field_flyteidl.core.TaskLog.ttl: - -ttl - (:ref:`google.protobuf.Duration `) - - -.. _api_enum_flyteidl.core.TaskLog.MessageFormat: - -Enum flyteidl.core.TaskLog.MessageFormat ----------------------------------------- - -`[flyteidl.core.TaskLog.MessageFormat proto] `_ - - -.. _api_enum_value_flyteidl.core.TaskLog.MessageFormat.UNKNOWN: - -UNKNOWN - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.core.TaskLog.MessageFormat.CSV: - -CSV - ⁣ - -.. _api_enum_value_flyteidl.core.TaskLog.MessageFormat.JSON: - -JSON - ⁣ - - -.. _api_msg_flyteidl.core.QualityOfServiceSpec: - -flyteidl.core.QualityOfServiceSpec ----------------------------------- - -`[flyteidl.core.QualityOfServiceSpec proto] `_ - -Represents customized execution run-time attributes. - -.. code-block:: json - - { - "queueing_budget": "{...}" - } - -.. _api_field_flyteidl.core.QualityOfServiceSpec.queueing_budget: - -queueing_budget - (:ref:`google.protobuf.Duration `) Indicates how much queueing delay an execution can tolerate. - - - - -.. _api_msg_flyteidl.core.QualityOfService: - -flyteidl.core.QualityOfService ------------------------------- - -`[flyteidl.core.QualityOfService proto] `_ - -Indicates the priority of an execution. - -.. code-block:: json - - { - "tier": "...", - "spec": "{...}" - } - -.. _api_field_flyteidl.core.QualityOfService.tier: - -tier - (:ref:`flyteidl.core.QualityOfService.Tier `) - - - Only one of :ref:`tier `, :ref:`spec ` may be set. - -.. _api_field_flyteidl.core.QualityOfService.spec: - -spec - (:ref:`flyteidl.core.QualityOfServiceSpec `) - - - Only one of :ref:`tier `, :ref:`spec ` may be set. - - -.. _api_enum_flyteidl.core.QualityOfService.Tier: - -Enum flyteidl.core.QualityOfService.Tier ----------------------------------------- - -`[flyteidl.core.QualityOfService.Tier proto] `_ - - -.. _api_enum_value_flyteidl.core.QualityOfService.Tier.UNDEFINED: - -UNDEFINED - *(DEFAULT)* ⁣Default: no quality of service specified. - - -.. _api_enum_value_flyteidl.core.QualityOfService.Tier.HIGH: - -HIGH - ⁣ - -.. _api_enum_value_flyteidl.core.QualityOfService.Tier.MEDIUM: - -MEDIUM - ⁣ - -.. _api_enum_value_flyteidl.core.QualityOfService.Tier.LOW: - -LOW - ⁣ - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/core/identifier.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/core/identifier.proto.rst deleted file mode 100644 index 2867f836ad..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/core/identifier.proto.rst +++ /dev/null @@ -1,193 +0,0 @@ -.. _api_file_flyteidl/core/identifier.proto: - -identifier.proto -============================== - -.. _api_msg_flyteidl.core.Identifier: - -flyteidl.core.Identifier ------------------------- - -`[flyteidl.core.Identifier proto] `_ - -Encapsulation of fields that uniquely identifies a Flyte resource. - -.. code-block:: json - - { - "resource_type": "...", - "project": "...", - "domain": "...", - "name": "...", - "version": "..." - } - -.. _api_field_flyteidl.core.Identifier.resource_type: - -resource_type - (:ref:`flyteidl.core.ResourceType `) Identifies the specific type of resource that this identifer corresponds to. - - -.. _api_field_flyteidl.core.Identifier.project: - -project - (`string `_) Name of the project the resource belongs to. - - -.. _api_field_flyteidl.core.Identifier.domain: - -domain - (`string `_) Name of the domain the resource belongs to. - A domain can be considered as a subset within a specific project. - - -.. _api_field_flyteidl.core.Identifier.name: - -name - (`string `_) User provided value for the resource. - - -.. _api_field_flyteidl.core.Identifier.version: - -version - (`string `_) Specific version of the resource. - - - - -.. _api_msg_flyteidl.core.WorkflowExecutionIdentifier: - -flyteidl.core.WorkflowExecutionIdentifier ------------------------------------------ - -`[flyteidl.core.WorkflowExecutionIdentifier proto] `_ - -Encapsulation of fields that uniquely identifies a Flyte workflow execution - -.. code-block:: json - - { - "project": "...", - "domain": "...", - "name": "..." - } - -.. _api_field_flyteidl.core.WorkflowExecutionIdentifier.project: - -project - (`string `_) Name of the project the resource belongs to. - - -.. _api_field_flyteidl.core.WorkflowExecutionIdentifier.domain: - -domain - (`string `_) Name of the domain the resource belongs to. - A domain can be considered as a subset within a specific project. - - -.. _api_field_flyteidl.core.WorkflowExecutionIdentifier.name: - -name - (`string `_) User or system provided value for the resource. - - - - -.. _api_msg_flyteidl.core.NodeExecutionIdentifier: - -flyteidl.core.NodeExecutionIdentifier -------------------------------------- - -`[flyteidl.core.NodeExecutionIdentifier proto] `_ - -Encapsulation of fields that identify a Flyte node execution entity. - -.. code-block:: json - - { - "node_id": "...", - "execution_id": "{...}" - } - -.. _api_field_flyteidl.core.NodeExecutionIdentifier.node_id: - -node_id - (`string `_) - -.. _api_field_flyteidl.core.NodeExecutionIdentifier.execution_id: - -execution_id - (:ref:`flyteidl.core.WorkflowExecutionIdentifier `) - - - -.. _api_msg_flyteidl.core.TaskExecutionIdentifier: - -flyteidl.core.TaskExecutionIdentifier -------------------------------------- - -`[flyteidl.core.TaskExecutionIdentifier proto] `_ - -Encapsulation of fields that identify a Flyte task execution entity. - -.. code-block:: json - - { - "task_id": "{...}", - "node_execution_id": "{...}", - "retry_attempt": "..." - } - -.. _api_field_flyteidl.core.TaskExecutionIdentifier.task_id: - -task_id - (:ref:`flyteidl.core.Identifier `) - -.. _api_field_flyteidl.core.TaskExecutionIdentifier.node_execution_id: - -node_execution_id - (:ref:`flyteidl.core.NodeExecutionIdentifier `) - -.. _api_field_flyteidl.core.TaskExecutionIdentifier.retry_attempt: - -retry_attempt - (`uint32 `_) - - -.. _api_enum_flyteidl.core.ResourceType: - -Enum flyteidl.core.ResourceType -------------------------------- - -`[flyteidl.core.ResourceType proto] `_ - -Indicates a resource type within Flyte. - -.. _api_enum_value_flyteidl.core.ResourceType.UNSPECIFIED: - -UNSPECIFIED - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.core.ResourceType.TASK: - -TASK - ⁣ - -.. _api_enum_value_flyteidl.core.ResourceType.WORKFLOW: - -WORKFLOW - ⁣ - -.. _api_enum_value_flyteidl.core.ResourceType.LAUNCH_PLAN: - -LAUNCH_PLAN - ⁣ - -.. _api_enum_value_flyteidl.core.ResourceType.DATASET: - -DATASET - ⁣A dataset represents an entity modeled in Flyte DataCatalog. A Dataset is also a versioned entity and can be a compilation of multiple individual objects. - Eventually all Catalog objects should be modeled similar to Flyte Objects. The Dataset entities makes it possible for the UI and CLI to act on the objects - in a similar manner to other Flyte objects - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/core/index.rst b/flyteidl/gen/pb-protodoc/flyteidl/core/index.rst deleted file mode 100644 index ea59e60733..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/core/index.rst +++ /dev/null @@ -1,28 +0,0 @@ -Core Flyte language specification -================================= - -These set of protocol buffers provides details of some of the core data -structures like Workflows, Tasks, Nodes, Literals. These are the specification -of the various entities in Flyte as well as the type system. - - - -.. toctree:: - :maxdepth: 1 - :caption: core - :name: coretoc - - catalog.proto - compiler.proto - condition.proto - dynamic_job.proto - errors.proto - execution.proto - identifier.proto - interface.proto - literals.proto - security.proto - tasks.proto - types.proto - workflow.proto - workflow_closure.proto diff --git a/flyteidl/gen/pb-protodoc/flyteidl/core/interface.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/core/interface.proto.rst deleted file mode 100644 index 1d0276a173..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/core/interface.proto.rst +++ /dev/null @@ -1,154 +0,0 @@ -.. _api_file_flyteidl/core/interface.proto: - -interface.proto -============================= - -.. _api_msg_flyteidl.core.Variable: - -flyteidl.core.Variable ----------------------- - -`[flyteidl.core.Variable proto] `_ - -Defines a strongly typed variable. - -.. code-block:: json - - { - "type": "{...}", - "description": "..." - } - -.. _api_field_flyteidl.core.Variable.type: - -type - (:ref:`flyteidl.core.LiteralType `) Variable literal type. - - -.. _api_field_flyteidl.core.Variable.description: - -description - (`string `_) optional string describing input variable - - - - -.. _api_msg_flyteidl.core.VariableMap: - -flyteidl.core.VariableMap -------------------------- - -`[flyteidl.core.VariableMap proto] `_ - -A map of Variables - -.. code-block:: json - - { - "variables": "{...}" - } - -.. _api_field_flyteidl.core.VariableMap.variables: - -variables - (map<`string `_, :ref:`flyteidl.core.Variable `>) Defines a map of variable names to variables. - - - - -.. _api_msg_flyteidl.core.TypedInterface: - -flyteidl.core.TypedInterface ----------------------------- - -`[flyteidl.core.TypedInterface proto] `_ - -Defines strongly typed inputs and outputs. - -.. code-block:: json - - { - "inputs": "{...}", - "outputs": "{...}" - } - -.. _api_field_flyteidl.core.TypedInterface.inputs: - -inputs - (:ref:`flyteidl.core.VariableMap `) - -.. _api_field_flyteidl.core.TypedInterface.outputs: - -outputs - (:ref:`flyteidl.core.VariableMap `) - - - -.. _api_msg_flyteidl.core.Parameter: - -flyteidl.core.Parameter ------------------------ - -`[flyteidl.core.Parameter proto] `_ - -A parameter is used as input to a launch plan and has -the special ability to have a default value or mark itself as required. - -.. code-block:: json - - { - "var": "{...}", - "default": "{...}", - "required": "..." - } - -.. _api_field_flyteidl.core.Parameter.var: - -var - (:ref:`flyteidl.core.Variable `) required Variable. Defines the type of the variable backing this parameter. - - -.. _api_field_flyteidl.core.Parameter.default: - -default - (:ref:`flyteidl.core.Literal `) Defines a default value that has to match the variable type defined. - - optional - - - Only one of :ref:`default `, :ref:`required ` may be set. - -.. _api_field_flyteidl.core.Parameter.required: - -required - (`bool `_) optional, is this value required to be filled. - - optional - - - Only one of :ref:`default `, :ref:`required ` may be set. - - - -.. _api_msg_flyteidl.core.ParameterMap: - -flyteidl.core.ParameterMap --------------------------- - -`[flyteidl.core.ParameterMap proto] `_ - -A map of Parameters. - -.. code-block:: json - - { - "parameters": "{...}" - } - -.. _api_field_flyteidl.core.ParameterMap.parameters: - -parameters - (map<`string `_, :ref:`flyteidl.core.Parameter `>) Defines a map of parameter names to parameters. - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/core/literals.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/core/literals.proto.rst deleted file mode 100644 index 9f29008514..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/core/literals.proto.rst +++ /dev/null @@ -1,563 +0,0 @@ -.. _api_file_flyteidl/core/literals.proto: - -literals.proto -============================ - -.. _api_msg_flyteidl.core.Primitive: - -flyteidl.core.Primitive ------------------------ - -`[flyteidl.core.Primitive proto] `_ - -Primitive Types - -.. code-block:: json - - { - "integer": "...", - "float_value": "...", - "string_value": "...", - "boolean": "...", - "datetime": "{...}", - "duration": "{...}" - } - -.. _api_field_flyteidl.core.Primitive.integer: - -integer - (`int64 `_) - Defines one of simple primitive types. These types will get translated into different programming languages as - described in https://developers.google.com/protocol-buffers/docs/proto#scalar. - - - Only one of :ref:`integer `, :ref:`float_value `, :ref:`string_value `, :ref:`boolean `, :ref:`datetime `, :ref:`duration ` may be set. - -.. _api_field_flyteidl.core.Primitive.float_value: - -float_value - (`double `_) - Defines one of simple primitive types. These types will get translated into different programming languages as - described in https://developers.google.com/protocol-buffers/docs/proto#scalar. - - - Only one of :ref:`integer `, :ref:`float_value `, :ref:`string_value `, :ref:`boolean `, :ref:`datetime `, :ref:`duration ` may be set. - -.. _api_field_flyteidl.core.Primitive.string_value: - -string_value - (`string `_) - Defines one of simple primitive types. These types will get translated into different programming languages as - described in https://developers.google.com/protocol-buffers/docs/proto#scalar. - - - Only one of :ref:`integer `, :ref:`float_value `, :ref:`string_value `, :ref:`boolean `, :ref:`datetime `, :ref:`duration ` may be set. - -.. _api_field_flyteidl.core.Primitive.boolean: - -boolean - (`bool `_) - Defines one of simple primitive types. These types will get translated into different programming languages as - described in https://developers.google.com/protocol-buffers/docs/proto#scalar. - - - Only one of :ref:`integer `, :ref:`float_value `, :ref:`string_value `, :ref:`boolean `, :ref:`datetime `, :ref:`duration ` may be set. - -.. _api_field_flyteidl.core.Primitive.datetime: - -datetime - (:ref:`google.protobuf.Timestamp `) - Defines one of simple primitive types. These types will get translated into different programming languages as - described in https://developers.google.com/protocol-buffers/docs/proto#scalar. - - - Only one of :ref:`integer `, :ref:`float_value `, :ref:`string_value `, :ref:`boolean `, :ref:`datetime `, :ref:`duration ` may be set. - -.. _api_field_flyteidl.core.Primitive.duration: - -duration - (:ref:`google.protobuf.Duration `) - Defines one of simple primitive types. These types will get translated into different programming languages as - described in https://developers.google.com/protocol-buffers/docs/proto#scalar. - - - Only one of :ref:`integer `, :ref:`float_value `, :ref:`string_value `, :ref:`boolean `, :ref:`datetime `, :ref:`duration ` may be set. - - - -.. _api_msg_flyteidl.core.Void: - -flyteidl.core.Void ------------------- - -`[flyteidl.core.Void proto] `_ - -Used to denote a nil/null/None assignment to a scalar value. The underlying LiteralType for Void is intentionally -undefined since it can be assigned to a scalar of any LiteralType. - -.. code-block:: json - - {} - - - - -.. _api_msg_flyteidl.core.Blob: - -flyteidl.core.Blob ------------------- - -`[flyteidl.core.Blob proto] `_ - -Refers to an offloaded set of files. It encapsulates the type of the store and a unique uri for where the data is. -There are no restrictions on how the uri is formatted since it will depend on how to interact with the store. - -.. code-block:: json - - { - "metadata": "{...}", - "uri": "..." - } - -.. _api_field_flyteidl.core.Blob.metadata: - -metadata - (:ref:`flyteidl.core.BlobMetadata `) - -.. _api_field_flyteidl.core.Blob.uri: - -uri - (`string `_) - - - -.. _api_msg_flyteidl.core.BlobMetadata: - -flyteidl.core.BlobMetadata --------------------------- - -`[flyteidl.core.BlobMetadata proto] `_ - - -.. code-block:: json - - { - "type": "{...}" - } - -.. _api_field_flyteidl.core.BlobMetadata.type: - -type - (:ref:`flyteidl.core.BlobType `) - - - -.. _api_msg_flyteidl.core.Binary: - -flyteidl.core.Binary --------------------- - -`[flyteidl.core.Binary proto] `_ - -A simple byte array with a tag to help different parts of the system communicate about what is in the byte array. -It's strongly advisable that consumers of this type define a unique tag and validate the tag before parsing the data. - -.. code-block:: json - - { - "value": "...", - "tag": "..." - } - -.. _api_field_flyteidl.core.Binary.value: - -value - (`bytes `_) - -.. _api_field_flyteidl.core.Binary.tag: - -tag - (`string `_) - - - -.. _api_msg_flyteidl.core.Schema: - -flyteidl.core.Schema --------------------- - -`[flyteidl.core.Schema proto] `_ - -A strongly typed schema that defines the interface of data retrieved from the underlying storage medium. - -.. code-block:: json - - { - "uri": "...", - "type": "{...}" - } - -.. _api_field_flyteidl.core.Schema.uri: - -uri - (`string `_) - -.. _api_field_flyteidl.core.Schema.type: - -type - (:ref:`flyteidl.core.SchemaType `) - - - -.. _api_msg_flyteidl.core.Scalar: - -flyteidl.core.Scalar --------------------- - -`[flyteidl.core.Scalar proto] `_ - - -.. code-block:: json - - { - "primitive": "{...}", - "blob": "{...}", - "binary": "{...}", - "schema": "{...}", - "none_type": "{...}", - "error": "{...}", - "generic": "{...}" - } - -.. _api_field_flyteidl.core.Scalar.primitive: - -primitive - (:ref:`flyteidl.core.Primitive `) - - - Only one of :ref:`primitive `, :ref:`blob `, :ref:`binary `, :ref:`schema `, :ref:`none_type `, :ref:`error `, :ref:`generic ` may be set. - -.. _api_field_flyteidl.core.Scalar.blob: - -blob - (:ref:`flyteidl.core.Blob `) - - - Only one of :ref:`primitive `, :ref:`blob `, :ref:`binary `, :ref:`schema `, :ref:`none_type `, :ref:`error `, :ref:`generic ` may be set. - -.. _api_field_flyteidl.core.Scalar.binary: - -binary - (:ref:`flyteidl.core.Binary `) - - - Only one of :ref:`primitive `, :ref:`blob `, :ref:`binary `, :ref:`schema `, :ref:`none_type `, :ref:`error `, :ref:`generic ` may be set. - -.. _api_field_flyteidl.core.Scalar.schema: - -schema - (:ref:`flyteidl.core.Schema `) - - - Only one of :ref:`primitive `, :ref:`blob `, :ref:`binary `, :ref:`schema `, :ref:`none_type `, :ref:`error `, :ref:`generic ` may be set. - -.. _api_field_flyteidl.core.Scalar.none_type: - -none_type - (:ref:`flyteidl.core.Void `) - - - Only one of :ref:`primitive `, :ref:`blob `, :ref:`binary `, :ref:`schema `, :ref:`none_type `, :ref:`error `, :ref:`generic ` may be set. - -.. _api_field_flyteidl.core.Scalar.error: - -error - (:ref:`flyteidl.core.Error `) - - - Only one of :ref:`primitive `, :ref:`blob `, :ref:`binary `, :ref:`schema `, :ref:`none_type `, :ref:`error `, :ref:`generic ` may be set. - -.. _api_field_flyteidl.core.Scalar.generic: - -generic - (:ref:`google.protobuf.Struct `) - - - Only one of :ref:`primitive `, :ref:`blob `, :ref:`binary `, :ref:`schema `, :ref:`none_type `, :ref:`error `, :ref:`generic ` may be set. - - - -.. _api_msg_flyteidl.core.Literal: - -flyteidl.core.Literal ---------------------- - -`[flyteidl.core.Literal proto] `_ - -A simple value. This supports any level of nesting (e.g. array of array of array of Blobs) as well as simple primitives. - -.. code-block:: json - - { - "scalar": "{...}", - "collection": "{...}", - "map": "{...}" - } - -.. _api_field_flyteidl.core.Literal.scalar: - -scalar - (:ref:`flyteidl.core.Scalar `) A simple value. - - - - Only one of :ref:`scalar `, :ref:`collection `, :ref:`map ` may be set. - -.. _api_field_flyteidl.core.Literal.collection: - -collection - (:ref:`flyteidl.core.LiteralCollection `) A collection of literals to allow nesting. - - - - Only one of :ref:`scalar `, :ref:`collection `, :ref:`map ` may be set. - -.. _api_field_flyteidl.core.Literal.map: - -map - (:ref:`flyteidl.core.LiteralMap `) A map of strings to literals. - - - - Only one of :ref:`scalar `, :ref:`collection `, :ref:`map ` may be set. - - - -.. _api_msg_flyteidl.core.LiteralCollection: - -flyteidl.core.LiteralCollection -------------------------------- - -`[flyteidl.core.LiteralCollection proto] `_ - -A collection of literals. This is a workaround since oneofs in proto messages cannot contain a repeated field. - -.. code-block:: json - - { - "literals": [] - } - -.. _api_field_flyteidl.core.LiteralCollection.literals: - -literals - (:ref:`flyteidl.core.Literal `) - - - -.. _api_msg_flyteidl.core.LiteralMap: - -flyteidl.core.LiteralMap ------------------------- - -`[flyteidl.core.LiteralMap proto] `_ - -A map of literals. This is a workaround since oneofs in proto messages cannot contain a repeated field. - -.. code-block:: json - - { - "literals": "{...}" - } - -.. _api_field_flyteidl.core.LiteralMap.literals: - -literals - (map<`string `_, :ref:`flyteidl.core.Literal `>) - - - -.. _api_msg_flyteidl.core.BindingDataCollection: - -flyteidl.core.BindingDataCollection ------------------------------------ - -`[flyteidl.core.BindingDataCollection proto] `_ - -A collection of BindingData items. - -.. code-block:: json - - { - "bindings": [] - } - -.. _api_field_flyteidl.core.BindingDataCollection.bindings: - -bindings - (:ref:`flyteidl.core.BindingData `) - - - -.. _api_msg_flyteidl.core.BindingDataMap: - -flyteidl.core.BindingDataMap ----------------------------- - -`[flyteidl.core.BindingDataMap proto] `_ - -A map of BindingData items. - -.. code-block:: json - - { - "bindings": "{...}" - } - -.. _api_field_flyteidl.core.BindingDataMap.bindings: - -bindings - (map<`string `_, :ref:`flyteidl.core.BindingData `>) - - - -.. _api_msg_flyteidl.core.BindingData: - -flyteidl.core.BindingData -------------------------- - -`[flyteidl.core.BindingData proto] `_ - -Specifies either a simple value or a reference to another output. - -.. code-block:: json - - { - "scalar": "{...}", - "collection": "{...}", - "promise": "{...}", - "map": "{...}" - } - -.. _api_field_flyteidl.core.BindingData.scalar: - -scalar - (:ref:`flyteidl.core.Scalar `) A simple scalar value. - - - - Only one of :ref:`scalar `, :ref:`collection `, :ref:`promise `, :ref:`map ` may be set. - -.. _api_field_flyteidl.core.BindingData.collection: - -collection - (:ref:`flyteidl.core.BindingDataCollection `) A collection of binding data. This allows nesting of binding data to any number - of levels. - - - - Only one of :ref:`scalar `, :ref:`collection `, :ref:`promise `, :ref:`map ` may be set. - -.. _api_field_flyteidl.core.BindingData.promise: - -promise - (:ref:`flyteidl.core.OutputReference `) References an output promised by another node. - - - - Only one of :ref:`scalar `, :ref:`collection `, :ref:`promise `, :ref:`map ` may be set. - -.. _api_field_flyteidl.core.BindingData.map: - -map - (:ref:`flyteidl.core.BindingDataMap `) A map of bindings. The key is always a string. - - - - Only one of :ref:`scalar `, :ref:`collection `, :ref:`promise `, :ref:`map ` may be set. - - - -.. _api_msg_flyteidl.core.Binding: - -flyteidl.core.Binding ---------------------- - -`[flyteidl.core.Binding proto] `_ - -An input/output binding of a variable to either static value or a node output. - -.. code-block:: json - - { - "var": "...", - "binding": "{...}" - } - -.. _api_field_flyteidl.core.Binding.var: - -var - (`string `_) Variable name must match an input/output variable of the node. - - -.. _api_field_flyteidl.core.Binding.binding: - -binding - (:ref:`flyteidl.core.BindingData `) Data to use to bind this variable. - - - - -.. _api_msg_flyteidl.core.KeyValuePair: - -flyteidl.core.KeyValuePair --------------------------- - -`[flyteidl.core.KeyValuePair proto] `_ - -A generic key value pair. - -.. code-block:: json - - { - "key": "...", - "value": "..." - } - -.. _api_field_flyteidl.core.KeyValuePair.key: - -key - (`string `_) equired. - - -.. _api_field_flyteidl.core.KeyValuePair.value: - -value - (`string `_) optional. - - - - -.. _api_msg_flyteidl.core.RetryStrategy: - -flyteidl.core.RetryStrategy ---------------------------- - -`[flyteidl.core.RetryStrategy proto] `_ - -Retry strategy associated with an executable unit. - -.. code-block:: json - - { - "retries": "..." - } - -.. _api_field_flyteidl.core.RetryStrategy.retries: - -retries - (`uint32 `_) Number of retries. Retries will be consumed when the job fails with a recoverable error. - The number of retries must be less than or equals to 10. - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/core/security.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/core/security.proto.rst deleted file mode 100644 index 160e101bf0..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/core/security.proto.rst +++ /dev/null @@ -1,283 +0,0 @@ -.. _api_file_flyteidl/core/security.proto: - -security.proto -============================ - -.. _api_msg_flyteidl.core.Secret: - -flyteidl.core.Secret --------------------- - -`[flyteidl.core.Secret proto] `_ - -Secret encapsulates information about the secret a task needs to proceed. An environment variable -FLYTE_SECRETS_ENV_PREFIX will be passed to indicate the prefix of the environment variables that will be present if -secrets are passed through environment variables. -FLYTE_SECRETS_DEFAULT_DIR will be passed to indicate the prefix of the path where secrets will be mounted if secrets -are passed through file mounts. - -.. code-block:: json - - { - "group": "...", - "group_version": "...", - "key": "...", - "mount_requirement": "..." - } - -.. _api_field_flyteidl.core.Secret.group: - -group - (`string `_) The name of the secret group where to find the key referenced below. For K8s secrets, this should be the name of - the v1/secret object. For Confidant, this should be the Credential name. For Vault, this should be the secret name. - For AWS Secret Manager, this should be the name of the secret. - +required - - -.. _api_field_flyteidl.core.Secret.group_version: - -group_version - (`string `_) The group version to fetch. This is not supported in all secret management systems. It'll be ignored for the ones - that do not support it. - +optional - - -.. _api_field_flyteidl.core.Secret.key: - -key - (`string `_) The name of the secret to mount. This has to match an existing secret in the system. It's up to the implementation - of the secret management system to require case sensitivity. For K8s secrets, Confidant and Vault, this should - match one of the keys inside the secret. For AWS Secret Manager, it's ignored. - +optional - - -.. _api_field_flyteidl.core.Secret.mount_requirement: - -mount_requirement - (:ref:`flyteidl.core.Secret.MountType `) mount_requirement is optional. Indicates where the secret has to be mounted. If provided, the execution will fail - if the underlying key management system cannot satisfy that requirement. If not provided, the default location - will depend on the key management system. - +optional - - - -.. _api_enum_flyteidl.core.Secret.MountType: - -Enum flyteidl.core.Secret.MountType ------------------------------------ - -`[flyteidl.core.Secret.MountType proto] `_ - - -.. _api_enum_value_flyteidl.core.Secret.MountType.ANY: - -ANY - *(DEFAULT)* ⁣Default case, indicates the client can tolerate either mounting options. - - -.. _api_enum_value_flyteidl.core.Secret.MountType.ENV_VAR: - -ENV_VAR - ⁣ENV_VAR indicates the secret needs to be mounted as an environment variable. - - -.. _api_enum_value_flyteidl.core.Secret.MountType.FILE: - -FILE - ⁣FILE indicates the secret needs to be mounted as a file. - - - -.. _api_msg_flyteidl.core.OAuth2Client: - -flyteidl.core.OAuth2Client --------------------------- - -`[flyteidl.core.OAuth2Client proto] `_ - -OAuth2Client encapsulates OAuth2 Client Credentials to be used when making calls on behalf of that task. - -.. code-block:: json - - { - "client_id": "...", - "client_secret": "{...}" - } - -.. _api_field_flyteidl.core.OAuth2Client.client_id: - -client_id - (`string `_) client_id is the public id for the client to use. The system will not perform any pre-auth validation that the - secret requested matches the client_id indicated here. - +required - - -.. _api_field_flyteidl.core.OAuth2Client.client_secret: - -client_secret - (:ref:`flyteidl.core.Secret `) client_secret is a reference to the secret used to authenticate the OAuth2 client. - +required - - - - -.. _api_msg_flyteidl.core.Identity: - -flyteidl.core.Identity ----------------------- - -`[flyteidl.core.Identity proto] `_ - -Identity encapsulates the various security identities a task can run as. It's up to the underlying plugin to pick the -right identity for the execution environment. - -.. code-block:: json - - { - "iam_role": "...", - "k8s_service_account": "...", - "oauth2_client": "{...}" - } - -.. _api_field_flyteidl.core.Identity.iam_role: - -iam_role - (`string `_) iam_role references the fully qualified name of Identity & Access Management role to impersonate. - - -.. _api_field_flyteidl.core.Identity.k8s_service_account: - -k8s_service_account - (`string `_) k8s_service_account references a kubernetes service account to impersonate. - - -.. _api_field_flyteidl.core.Identity.oauth2_client: - -oauth2_client - (:ref:`flyteidl.core.OAuth2Client `) oauth2_client references an oauth2 client. Backend plugins can use this information to impersonate the client when - making external calls. - - - - -.. _api_msg_flyteidl.core.OAuth2TokenRequest: - -flyteidl.core.OAuth2TokenRequest --------------------------------- - -`[flyteidl.core.OAuth2TokenRequest proto] `_ - -OAuth2TokenRequest encapsulates information needed to request an OAuth2 token. -FLYTE_TOKENS_ENV_PREFIX will be passed to indicate the prefix of the environment variables that will be present if -tokens are passed through environment variables. -FLYTE_TOKENS_PATH_PREFIX will be passed to indicate the prefix of the path where secrets will be mounted if tokens -are passed through file mounts. - -.. code-block:: json - - { - "name": "...", - "type": "...", - "client": "{...}", - "idp_discovery_endpoint": "...", - "token_endpoint": "..." - } - -.. _api_field_flyteidl.core.OAuth2TokenRequest.name: - -name - (`string `_) name indicates a unique id for the token request within this task token requests. It'll be used as a suffix for - environment variables and as a filename for mounting tokens as files. - +required - - -.. _api_field_flyteidl.core.OAuth2TokenRequest.type: - -type - (:ref:`flyteidl.core.OAuth2TokenRequest.Type `) type indicates the type of the request to make. Defaults to CLIENT_CREDENTIALS. - +required - - -.. _api_field_flyteidl.core.OAuth2TokenRequest.client: - -client - (:ref:`flyteidl.core.OAuth2Client `) client references the client_id/secret to use to request the OAuth2 token. - +required - - -.. _api_field_flyteidl.core.OAuth2TokenRequest.idp_discovery_endpoint: - -idp_discovery_endpoint - (`string `_) idp_discovery_endpoint references the discovery endpoint used to retrieve token endpoint and other related - information. - +optional - - -.. _api_field_flyteidl.core.OAuth2TokenRequest.token_endpoint: - -token_endpoint - (`string `_) token_endpoint references the token issuance endpoint. If idp_discovery_endpoint is not provided, this parameter is - mandatory. - +optional - - - -.. _api_enum_flyteidl.core.OAuth2TokenRequest.Type: - -Enum flyteidl.core.OAuth2TokenRequest.Type ------------------------------------------- - -`[flyteidl.core.OAuth2TokenRequest.Type proto] `_ - -Type of the token requested. - -.. _api_enum_value_flyteidl.core.OAuth2TokenRequest.Type.CLIENT_CREDENTIALS: - -CLIENT_CREDENTIALS - *(DEFAULT)* ⁣CLIENT_CREDENTIALS indicates a 2-legged OAuth token requested using client credentials. - - - -.. _api_msg_flyteidl.core.SecurityContext: - -flyteidl.core.SecurityContext ------------------------------ - -`[flyteidl.core.SecurityContext proto] `_ - -SecurityContext holds security attributes that apply to tasks. - -.. code-block:: json - - { - "run_as": "{...}", - "secrets": [], - "tokens": [] - } - -.. _api_field_flyteidl.core.SecurityContext.run_as: - -run_as - (:ref:`flyteidl.core.Identity `) run_as encapsulates the identity a pod should run as. If the task fills in multiple fields here, it'll be up to the - backend plugin to choose the appropriate identity for the execution engine the task will run on. - - -.. _api_field_flyteidl.core.SecurityContext.secrets: - -secrets - (:ref:`flyteidl.core.Secret `) secrets indicate the list of secrets the task needs in order to proceed. Secrets will be mounted/passed to the - pod as it starts. If the plugin responsible for kicking of the task will not run it on a flyte cluster (e.g. AWS - Batch), it's the responsibility of the plugin to fetch the secret (which means propeller identity will need access - to the secret) and to pass it to the remote execution engine. - - -.. _api_field_flyteidl.core.SecurityContext.tokens: - -tokens - (:ref:`flyteidl.core.OAuth2TokenRequest `) tokens indicate the list of token requests the task needs in order to proceed. Tokens will be mounted/passed to the - pod as it starts. If the plugin responsible for kicking of the task will not run it on a flyte cluster (e.g. AWS - Batch), it's the responsibility of the plugin to fetch the secret (which means propeller identity will need access - to the secret) and to pass it to the remote execution engine. - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/core/tasks.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/core/tasks.proto.rst deleted file mode 100644 index c9591c90d1..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/core/tasks.proto.rst +++ /dev/null @@ -1,597 +0,0 @@ -.. _api_file_flyteidl/core/tasks.proto: - -tasks.proto -========================= - -For interruptible we will populate it at the node level but require it be part of TaskMetadata -for a user to set the value. -We are using oneof instead of bool because otherwise we would be unable to distinguish between value being -set by the user or defaulting to false. -The logic of handling precedence will be done as part of flytepropeller. - -.. _api_msg_flyteidl.core.Resources: - -flyteidl.core.Resources ------------------------ - -`[flyteidl.core.Resources proto] `_ - -A customizable interface to convey resources requested for a container. This can be interpretted differently for different -container engines. - -.. code-block:: json - - { - "requests": [], - "limits": [] - } - -.. _api_field_flyteidl.core.Resources.requests: - -requests - (:ref:`flyteidl.core.Resources.ResourceEntry `) The desired set of resources requested. ResourceNames must be unique within the list. - - -.. _api_field_flyteidl.core.Resources.limits: - -limits - (:ref:`flyteidl.core.Resources.ResourceEntry `) Defines a set of bounds (e.g. min/max) within which the task can reliably run. ResourceNames must be unique - within the list. - - -.. _api_msg_flyteidl.core.Resources.ResourceEntry: - -flyteidl.core.Resources.ResourceEntry -------------------------------------- - -`[flyteidl.core.Resources.ResourceEntry proto] `_ - -Encapsulates a resource name and value. - -.. code-block:: json - - { - "name": "...", - "value": "..." - } - -.. _api_field_flyteidl.core.Resources.ResourceEntry.name: - -name - (:ref:`flyteidl.core.Resources.ResourceName `) Resource name. - - -.. _api_field_flyteidl.core.Resources.ResourceEntry.value: - -value - (`string `_) Value must be a valid k8s quantity. See - https://github.com/kubernetes/apimachinery/blob/master/pkg/api/resource/quantity.go#L30-L80 - - - - -.. _api_enum_flyteidl.core.Resources.ResourceName: - -Enum flyteidl.core.Resources.ResourceName ------------------------------------------ - -`[flyteidl.core.Resources.ResourceName proto] `_ - -Known resource names. - -.. _api_enum_value_flyteidl.core.Resources.ResourceName.UNKNOWN: - -UNKNOWN - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.core.Resources.ResourceName.CPU: - -CPU - ⁣ - -.. _api_enum_value_flyteidl.core.Resources.ResourceName.GPU: - -GPU - ⁣ - -.. _api_enum_value_flyteidl.core.Resources.ResourceName.MEMORY: - -MEMORY - ⁣ - -.. _api_enum_value_flyteidl.core.Resources.ResourceName.STORAGE: - -STORAGE - ⁣ - - -.. _api_msg_flyteidl.core.RuntimeMetadata: - -flyteidl.core.RuntimeMetadata ------------------------------ - -`[flyteidl.core.RuntimeMetadata proto] `_ - -Runtime information. This is losely defined to allow for extensibility. - -.. code-block:: json - - { - "type": "...", - "version": "...", - "flavor": "..." - } - -.. _api_field_flyteidl.core.RuntimeMetadata.type: - -type - (:ref:`flyteidl.core.RuntimeMetadata.RuntimeType `) Type of runtime. - - -.. _api_field_flyteidl.core.RuntimeMetadata.version: - -version - (`string `_) Version of the runtime. All versions should be backward compatible. However, certain cases call for version - checks to ensure tighter validation or setting expectations. - - -.. _api_field_flyteidl.core.RuntimeMetadata.flavor: - -flavor - (`string `_) optional It can be used to provide extra information about the runtime (e.g. python, golang... etc.). - - - -.. _api_enum_flyteidl.core.RuntimeMetadata.RuntimeType: - -Enum flyteidl.core.RuntimeMetadata.RuntimeType ----------------------------------------------- - -`[flyteidl.core.RuntimeMetadata.RuntimeType proto] `_ - - -.. _api_enum_value_flyteidl.core.RuntimeMetadata.RuntimeType.OTHER: - -OTHER - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.core.RuntimeMetadata.RuntimeType.FLYTE_SDK: - -FLYTE_SDK - ⁣ - - -.. _api_msg_flyteidl.core.TaskMetadata: - -flyteidl.core.TaskMetadata --------------------------- - -`[flyteidl.core.TaskMetadata proto] `_ - -Task Metadata - -.. code-block:: json - - { - "discoverable": "...", - "runtime": "{...}", - "timeout": "{...}", - "retries": "{...}", - "discovery_version": "...", - "deprecated_error_message": "...", - "interruptible": "..." - } - -.. _api_field_flyteidl.core.TaskMetadata.discoverable: - -discoverable - (`bool `_) Indicates whether the system should attempt to lookup this task's output to avoid duplication of work. - - -.. _api_field_flyteidl.core.TaskMetadata.runtime: - -runtime - (:ref:`flyteidl.core.RuntimeMetadata `) Runtime information about the task. - - -.. _api_field_flyteidl.core.TaskMetadata.timeout: - -timeout - (:ref:`google.protobuf.Duration `) The overall timeout of a task including user-triggered retries. - - -.. _api_field_flyteidl.core.TaskMetadata.retries: - -retries - (:ref:`flyteidl.core.RetryStrategy `) Number of retries per task. - - -.. _api_field_flyteidl.core.TaskMetadata.discovery_version: - -discovery_version - (`string `_) Indicates a logical version to apply to this task for the purpose of discovery. - - -.. _api_field_flyteidl.core.TaskMetadata.deprecated_error_message: - -deprecated_error_message - (`string `_) If set, this indicates that this task is deprecated. This will enable owners of tasks to notify consumers - of the ending of support for a given task. - - -.. _api_field_flyteidl.core.TaskMetadata.interruptible: - -interruptible - (`bool `_) - Identify whether task is interruptible - - - - -.. _api_msg_flyteidl.core.TaskTemplate: - -flyteidl.core.TaskTemplate --------------------------- - -`[flyteidl.core.TaskTemplate proto] `_ - -A Task structure that uniquely identifies a task in the system -Tasks are registered as a first step in the system. - -.. code-block:: json - - { - "id": "{...}", - "type": "...", - "metadata": "{...}", - "interface": "{...}", - "custom": "{...}", - "container": "{...}", - "task_type_version": "...", - "security_context": "{...}", - "config": "{...}" - } - -.. _api_field_flyteidl.core.TaskTemplate.id: - -id - (:ref:`flyteidl.core.Identifier `) Auto generated taskId by the system. Task Id uniquely identifies this task globally. - - -.. _api_field_flyteidl.core.TaskTemplate.type: - -type - (`string `_) A predefined yet extensible Task type identifier. This can be used to customize any of the components. If no - extensions are provided in the system, Flyte will resolve the this task to its TaskCategory and default the - implementation registered for the TaskCategory. - - -.. _api_field_flyteidl.core.TaskTemplate.metadata: - -metadata - (:ref:`flyteidl.core.TaskMetadata `) Extra metadata about the task. - - -.. _api_field_flyteidl.core.TaskTemplate.interface: - -interface - (:ref:`flyteidl.core.TypedInterface `) A strongly typed interface for the task. This enables others to use this task within a workflow and gauarantees - compile-time validation of the workflow to avoid costly runtime failures. - - -.. _api_field_flyteidl.core.TaskTemplate.custom: - -custom - (:ref:`google.protobuf.Struct `) Custom data about the task. This is extensible to allow various plugins in the system. - - -.. _api_field_flyteidl.core.TaskTemplate.container: - -container - (:ref:`flyteidl.core.Container `) - Known target types that the system will guarantee plugins for. Custom SDK plugins are allowed to set these if needed. - If no corresponding execution-layer plugins are found, the system will default to handling these using built-in - handlers. - - -.. _api_field_flyteidl.core.TaskTemplate.task_type_version: - -task_type_version - (`int32 `_) This can be used to customize task handling at execution time for the same task type. - - -.. _api_field_flyteidl.core.TaskTemplate.security_context: - -security_context - (:ref:`flyteidl.core.SecurityContext `) security_context encapsulates security attributes requested to run this task. - - -.. _api_field_flyteidl.core.TaskTemplate.config: - -config - (map<`string `_, `string `_>) Metadata about the custom defined for this task. This is extensible to allow various plugins in the system - to use as required. - reserve the field numbers 1 through 15 for very frequently occurring message elements - - - - -.. _api_msg_flyteidl.core.ContainerPort: - -flyteidl.core.ContainerPort ---------------------------- - -`[flyteidl.core.ContainerPort proto] `_ - -Defines port properties for a container. - -.. code-block:: json - - { - "container_port": "..." - } - -.. _api_field_flyteidl.core.ContainerPort.container_port: - -container_port - (`uint32 `_) Number of port to expose on the pod's IP address. - This must be a valid port number, 0 < x < 65536. - - - - -.. _api_msg_flyteidl.core.Container: - -flyteidl.core.Container ------------------------ - -`[flyteidl.core.Container proto] `_ - - -.. code-block:: json - - { - "image": "...", - "command": [], - "args": [], - "resources": "{...}", - "env": [], - "config": [], - "ports": [], - "data_config": "{...}" - } - -.. _api_field_flyteidl.core.Container.image: - -image - (`string `_) Container image url. Eg: docker/redis:latest - - -.. _api_field_flyteidl.core.Container.command: - -command - (`string `_) Command to be executed, if not provided, the default entrypoint in the container image will be used. - - -.. _api_field_flyteidl.core.Container.args: - -args - (`string `_) These will default to Flyte given paths. If provided, the system will not append known paths. If the task still - needs flyte's inputs and outputs path, add $(FLYTE_INPUT_FILE), $(FLYTE_OUTPUT_FILE) wherever makes sense and the - system will populate these before executing the container. - - -.. _api_field_flyteidl.core.Container.resources: - -resources - (:ref:`flyteidl.core.Resources `) Container resources requirement as specified by the container engine. - - -.. _api_field_flyteidl.core.Container.env: - -env - (:ref:`flyteidl.core.KeyValuePair `) Environment variables will be set as the container is starting up. - - -.. _api_field_flyteidl.core.Container.config: - -config - (:ref:`flyteidl.core.KeyValuePair `) Allows extra configs to be available for the container. - TODO: elaborate on how configs will become available. - Deprecated, please use TaskTemplate.config instead. - - -.. _api_field_flyteidl.core.Container.ports: - -ports - (:ref:`flyteidl.core.ContainerPort `) Ports to open in the container. This feature is not supported by all execution engines. (e.g. supported on K8s but - not supported on AWS Batch) - Only K8s - - -.. _api_field_flyteidl.core.Container.data_config: - -data_config - (:ref:`flyteidl.core.DataLoadingConfig `) BETA: Optional configuration for DataLoading. If not specified, then default values are used. - This makes it possible to to run a completely portable container, that uses inputs and outputs - only from the local file-system and without having any reference to flyteidl. This is supported only on K8s at the moment. - If data loading is enabled, then data will be mounted in accompanying directories specified in the DataLoadingConfig. If the directories - are not specified, inputs will be mounted onto and outputs will be uploaded from a pre-determined file-system path. Refer to the documentation - to understand the default paths. - Only K8s - - - - -.. _api_msg_flyteidl.core.IOStrategy: - -flyteidl.core.IOStrategy ------------------------- - -`[flyteidl.core.IOStrategy proto] `_ - -Strategy to use when dealing with Blob, Schema, or multipart blob data (large datasets) - -.. code-block:: json - - { - "download_mode": "...", - "upload_mode": "..." - } - -.. _api_field_flyteidl.core.IOStrategy.download_mode: - -download_mode - (:ref:`flyteidl.core.IOStrategy.DownloadMode `) Mode to use to manage downloads - - -.. _api_field_flyteidl.core.IOStrategy.upload_mode: - -upload_mode - (:ref:`flyteidl.core.IOStrategy.UploadMode `) Mode to use to manage uploads - - - -.. _api_enum_flyteidl.core.IOStrategy.DownloadMode: - -Enum flyteidl.core.IOStrategy.DownloadMode ------------------------------------------- - -`[flyteidl.core.IOStrategy.DownloadMode proto] `_ - -Mode to use for downloading - -.. _api_enum_value_flyteidl.core.IOStrategy.DownloadMode.DOWNLOAD_EAGER: - -DOWNLOAD_EAGER - *(DEFAULT)* ⁣All data will be downloaded before the main container is executed - - -.. _api_enum_value_flyteidl.core.IOStrategy.DownloadMode.DOWNLOAD_STREAM: - -DOWNLOAD_STREAM - ⁣Data will be downloaded as a stream and an End-Of-Stream marker will be written to indicate all data has been downloaded. Refer to protocol for details - - -.. _api_enum_value_flyteidl.core.IOStrategy.DownloadMode.DO_NOT_DOWNLOAD: - -DO_NOT_DOWNLOAD - ⁣Large objects (offloaded) will not be downloaded - - - -.. _api_enum_flyteidl.core.IOStrategy.UploadMode: - -Enum flyteidl.core.IOStrategy.UploadMode ----------------------------------------- - -`[flyteidl.core.IOStrategy.UploadMode proto] `_ - -Mode to use for uploading - -.. _api_enum_value_flyteidl.core.IOStrategy.UploadMode.UPLOAD_ON_EXIT: - -UPLOAD_ON_EXIT - *(DEFAULT)* ⁣All data will be uploaded after the main container exits - - -.. _api_enum_value_flyteidl.core.IOStrategy.UploadMode.UPLOAD_EAGER: - -UPLOAD_EAGER - ⁣Data will be uploaded as it appears. Refer to protocol specification for details - - -.. _api_enum_value_flyteidl.core.IOStrategy.UploadMode.DO_NOT_UPLOAD: - -DO_NOT_UPLOAD - ⁣Data will not be uploaded, only references will be written - - - -.. _api_msg_flyteidl.core.DataLoadingConfig: - -flyteidl.core.DataLoadingConfig -------------------------------- - -`[flyteidl.core.DataLoadingConfig proto] `_ - -This configuration allows executing raw containers in Flyte using the Flyte CoPilot system. -Flyte CoPilot, eliminates the needs of flytekit or sdk inside the container. Any inputs required by the users container are side-loaded in the input_path -Any outputs generated by the user container - within output_path are automatically uploaded. - -.. code-block:: json - - { - "enabled": "...", - "input_path": "...", - "output_path": "...", - "format": "...", - "io_strategy": "{...}" - } - -.. _api_field_flyteidl.core.DataLoadingConfig.enabled: - -enabled - (`bool `_) Flag enables DataLoading Config. If this is not set, data loading will not be used! - - -.. _api_field_flyteidl.core.DataLoadingConfig.input_path: - -input_path - (`string `_) File system path (start at root). This folder will contain all the inputs exploded to a separate file. - Example, if the input interface needs (x: int, y: blob, z: multipart_blob) and the input path is "/var/flyte/inputs", then the file system will look like - /var/flyte/inputs/inputs. .pb .json .yaml> -> Format as defined previously. The Blob and Multipart blob will reference local filesystem instead of remote locations - /var/flyte/inputs/x -> X is a file that contains the value of x (integer) in string format - /var/flyte/inputs/y -> Y is a file in Binary format - /var/flyte/inputs/z/... -> Note Z itself is a directory - More information about the protocol - refer to docs #TODO reference docs here - - -.. _api_field_flyteidl.core.DataLoadingConfig.output_path: - -output_path - (`string `_) File system path (start at root). This folder should contain all the outputs for the task as individual files and/or an error text file - - -.. _api_field_flyteidl.core.DataLoadingConfig.format: - -format - (:ref:`flyteidl.core.DataLoadingConfig.LiteralMapFormat `) In the inputs folder, there will be an additional summary/metadata file that contains references to all files or inlined primitive values. - This format decides the actual encoding for the data. Refer to the encoding to understand the specifics of the contents and the encoding - - -.. _api_field_flyteidl.core.DataLoadingConfig.io_strategy: - -io_strategy - (:ref:`flyteidl.core.IOStrategy `) - - -.. _api_enum_flyteidl.core.DataLoadingConfig.LiteralMapFormat: - -Enum flyteidl.core.DataLoadingConfig.LiteralMapFormat ------------------------------------------------------ - -`[flyteidl.core.DataLoadingConfig.LiteralMapFormat proto] `_ - -LiteralMapFormat decides the encoding format in which the input metadata should be made available to the containers. -If the user has access to the protocol buffer definitions, it is recommended to use the PROTO format. -JSON and YAML do not need any protobuf definitions to read it -All remote references in core.LiteralMap are replaced with local filesystem references (the data is downloaded to local filesystem) - -.. _api_enum_value_flyteidl.core.DataLoadingConfig.LiteralMapFormat.JSON: - -JSON - *(DEFAULT)* ⁣JSON / YAML for the metadata (which contains inlined primitive values). The representation is inline with the standard json specification as specified - https://www.json.org/json-en.html - - -.. _api_enum_value_flyteidl.core.DataLoadingConfig.LiteralMapFormat.YAML: - -YAML - ⁣ - -.. _api_enum_value_flyteidl.core.DataLoadingConfig.LiteralMapFormat.PROTO: - -PROTO - ⁣Proto is a serialized binary of `core.LiteralMap` defined in flyteidl/core - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/core/types.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/core/types.proto.rst deleted file mode 100644 index 9d5eb65106..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/core/types.proto.rst +++ /dev/null @@ -1,335 +0,0 @@ -.. _api_file_flyteidl/core/types.proto: - -types.proto -========================= - -.. _api_msg_flyteidl.core.SchemaType: - -flyteidl.core.SchemaType ------------------------- - -`[flyteidl.core.SchemaType proto] `_ - -Defines schema columns and types to strongly type-validate schemas interoperability. - -.. code-block:: json - - { - "columns": [] - } - -.. _api_field_flyteidl.core.SchemaType.columns: - -columns - (:ref:`flyteidl.core.SchemaType.SchemaColumn `) A list of ordered columns this schema comprises of. - - -.. _api_msg_flyteidl.core.SchemaType.SchemaColumn: - -flyteidl.core.SchemaType.SchemaColumn -------------------------------------- - -`[flyteidl.core.SchemaType.SchemaColumn proto] `_ - - -.. code-block:: json - - { - "name": "...", - "type": "..." - } - -.. _api_field_flyteidl.core.SchemaType.SchemaColumn.name: - -name - (`string `_) A unique name -within the schema type- for the column - - -.. _api_field_flyteidl.core.SchemaType.SchemaColumn.type: - -type - (:ref:`flyteidl.core.SchemaType.SchemaColumn.SchemaColumnType `) The column type. This allows a limited set of types currently. - - - -.. _api_enum_flyteidl.core.SchemaType.SchemaColumn.SchemaColumnType: - -Enum flyteidl.core.SchemaType.SchemaColumn.SchemaColumnType ------------------------------------------------------------ - -`[flyteidl.core.SchemaType.SchemaColumn.SchemaColumnType proto] `_ - - -.. _api_enum_value_flyteidl.core.SchemaType.SchemaColumn.SchemaColumnType.INTEGER: - -INTEGER - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.core.SchemaType.SchemaColumn.SchemaColumnType.FLOAT: - -FLOAT - ⁣ - -.. _api_enum_value_flyteidl.core.SchemaType.SchemaColumn.SchemaColumnType.STRING: - -STRING - ⁣ - -.. _api_enum_value_flyteidl.core.SchemaType.SchemaColumn.SchemaColumnType.BOOLEAN: - -BOOLEAN - ⁣ - -.. _api_enum_value_flyteidl.core.SchemaType.SchemaColumn.SchemaColumnType.DATETIME: - -DATETIME - ⁣ - -.. _api_enum_value_flyteidl.core.SchemaType.SchemaColumn.SchemaColumnType.DURATION: - -DURATION - ⁣ - - - -.. _api_msg_flyteidl.core.BlobType: - -flyteidl.core.BlobType ----------------------- - -`[flyteidl.core.BlobType proto] `_ - -Defines type behavior for blob objects - -.. code-block:: json - - { - "format": "...", - "dimensionality": "..." - } - -.. _api_field_flyteidl.core.BlobType.format: - -format - (`string `_) Format can be a free form string understood by SDK/UI etc like - csv, parquet etc - - -.. _api_field_flyteidl.core.BlobType.dimensionality: - -dimensionality - (:ref:`flyteidl.core.BlobType.BlobDimensionality `) - - -.. _api_enum_flyteidl.core.BlobType.BlobDimensionality: - -Enum flyteidl.core.BlobType.BlobDimensionality ----------------------------------------------- - -`[flyteidl.core.BlobType.BlobDimensionality proto] `_ - - -.. _api_enum_value_flyteidl.core.BlobType.BlobDimensionality.SINGLE: - -SINGLE - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.core.BlobType.BlobDimensionality.MULTIPART: - -MULTIPART - ⁣ - - -.. _api_msg_flyteidl.core.LiteralType: - -flyteidl.core.LiteralType -------------------------- - -`[flyteidl.core.LiteralType proto] `_ - -Defines a strong type to allow type checking between interfaces. - -.. code-block:: json - - { - "simple": "...", - "schema": "{...}", - "collection_type": "{...}", - "map_value_type": "{...}", - "blob": "{...}", - "metadata": "{...}" - } - -.. _api_field_flyteidl.core.LiteralType.simple: - -simple - (:ref:`flyteidl.core.SimpleType `) A simple type that can be compared one-to-one with another. - - - - Only one of :ref:`simple `, :ref:`schema `, :ref:`collection_type `, :ref:`map_value_type `, :ref:`blob ` may be set. - -.. _api_field_flyteidl.core.LiteralType.schema: - -schema - (:ref:`flyteidl.core.SchemaType `) A complex type that requires matching of inner fields. - - - - Only one of :ref:`simple `, :ref:`schema `, :ref:`collection_type `, :ref:`map_value_type `, :ref:`blob ` may be set. - -.. _api_field_flyteidl.core.LiteralType.collection_type: - -collection_type - (:ref:`flyteidl.core.LiteralType `) Defines the type of the value of a collection. Only homogeneous collections are allowed. - - - - Only one of :ref:`simple `, :ref:`schema `, :ref:`collection_type `, :ref:`map_value_type `, :ref:`blob ` may be set. - -.. _api_field_flyteidl.core.LiteralType.map_value_type: - -map_value_type - (:ref:`flyteidl.core.LiteralType `) Defines the type of the value of a map type. The type of the key is always a string. - - - - Only one of :ref:`simple `, :ref:`schema `, :ref:`collection_type `, :ref:`map_value_type `, :ref:`blob ` may be set. - -.. _api_field_flyteidl.core.LiteralType.blob: - -blob - (:ref:`flyteidl.core.BlobType `) A blob might have specialized implementation details depending on associated metadata. - - - - Only one of :ref:`simple `, :ref:`schema `, :ref:`collection_type `, :ref:`map_value_type `, :ref:`blob ` may be set. - -.. _api_field_flyteidl.core.LiteralType.metadata: - -metadata - (:ref:`google.protobuf.Struct `) This field contains type metadata that is descriptive of the type, but is NOT considered in type-checking. This might be used by - consumers to identify special behavior or display extended information for the type. - - - - -.. _api_msg_flyteidl.core.OutputReference: - -flyteidl.core.OutputReference ------------------------------ - -`[flyteidl.core.OutputReference proto] `_ - -A reference to an output produced by a node. The type can be retrieved -and validated- from -the underlying interface of the node. - -.. code-block:: json - - { - "node_id": "...", - "var": "..." - } - -.. _api_field_flyteidl.core.OutputReference.node_id: - -node_id - (`string `_) Node id must exist at the graph layer. - - -.. _api_field_flyteidl.core.OutputReference.var: - -var - (`string `_) Variable name must refer to an output variable for the node. - - - - -.. _api_msg_flyteidl.core.Error: - -flyteidl.core.Error -------------------- - -`[flyteidl.core.Error proto] `_ - -Represents an error thrown from a node. - -.. code-block:: json - - { - "failed_node_id": "...", - "message": "..." - } - -.. _api_field_flyteidl.core.Error.failed_node_id: - -failed_node_id - (`string `_) The node id that threw the error. - - -.. _api_field_flyteidl.core.Error.message: - -message - (`string `_) Error message thrown. - - - -.. _api_enum_flyteidl.core.SimpleType: - -Enum flyteidl.core.SimpleType ------------------------------ - -`[flyteidl.core.SimpleType proto] `_ - -Define a set of simple types. - -.. _api_enum_value_flyteidl.core.SimpleType.NONE: - -NONE - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.core.SimpleType.INTEGER: - -INTEGER - ⁣ - -.. _api_enum_value_flyteidl.core.SimpleType.FLOAT: - -FLOAT - ⁣ - -.. _api_enum_value_flyteidl.core.SimpleType.STRING: - -STRING - ⁣ - -.. _api_enum_value_flyteidl.core.SimpleType.BOOLEAN: - -BOOLEAN - ⁣ - -.. _api_enum_value_flyteidl.core.SimpleType.DATETIME: - -DATETIME - ⁣ - -.. _api_enum_value_flyteidl.core.SimpleType.DURATION: - -DURATION - ⁣ - -.. _api_enum_value_flyteidl.core.SimpleType.BINARY: - -BINARY - ⁣ - -.. _api_enum_value_flyteidl.core.SimpleType.ERROR: - -ERROR - ⁣ - -.. _api_enum_value_flyteidl.core.SimpleType.STRUCT: - -STRUCT - ⁣ - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/core/workflow.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/core/workflow.proto.rst deleted file mode 100644 index 06c91ba315..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/core/workflow.proto.rst +++ /dev/null @@ -1,494 +0,0 @@ -.. _api_file_flyteidl/core/workflow.proto: - -workflow.proto -============================ - -.. _api_msg_flyteidl.core.IfBlock: - -flyteidl.core.IfBlock ---------------------- - -`[flyteidl.core.IfBlock proto] `_ - -Defines a condition and the execution unit that should be executed if the condition is satisfied. - -.. code-block:: json - - { - "condition": "{...}", - "then_node": "{...}" - } - -.. _api_field_flyteidl.core.IfBlock.condition: - -condition - (:ref:`flyteidl.core.BooleanExpression `) - -.. _api_field_flyteidl.core.IfBlock.then_node: - -then_node - (:ref:`flyteidl.core.Node `) - - - -.. _api_msg_flyteidl.core.IfElseBlock: - -flyteidl.core.IfElseBlock -------------------------- - -`[flyteidl.core.IfElseBlock proto] `_ - -Defines a series of if/else blocks. The first branch whose condition evaluates to true is the one to execute. -If no conditions were satisfied, the else_node or the error will execute. - -.. code-block:: json - - { - "case": "{...}", - "other": [], - "else_node": "{...}", - "error": "{...}" - } - -.. _api_field_flyteidl.core.IfElseBlock.case: - -case - (:ref:`flyteidl.core.IfBlock `) required. First condition to evaluate. - - -.. _api_field_flyteidl.core.IfElseBlock.other: - -other - (:ref:`flyteidl.core.IfBlock `) optional. Additional branches to evaluate. - - -.. _api_field_flyteidl.core.IfElseBlock.else_node: - -else_node - (:ref:`flyteidl.core.Node `) The node to execute in case none of the branches were taken. - - required. - - - Only one of :ref:`else_node `, :ref:`error ` may be set. - -.. _api_field_flyteidl.core.IfElseBlock.error: - -error - (:ref:`flyteidl.core.Error `) An error to throw in case none of the branches were taken. - - required. - - - Only one of :ref:`else_node `, :ref:`error ` may be set. - - - -.. _api_msg_flyteidl.core.BranchNode: - -flyteidl.core.BranchNode ------------------------- - -`[flyteidl.core.BranchNode proto] `_ - -BranchNode is a special node that alter the flow of the workflow graph. It allows the control flow to branch at -runtime based on a series of conditions that get evaluated on various parameters (e.g. inputs, primtives). - -.. code-block:: json - - { - "if_else": "{...}" - } - -.. _api_field_flyteidl.core.BranchNode.if_else: - -if_else - (:ref:`flyteidl.core.IfElseBlock `) required - - - - -.. _api_msg_flyteidl.core.TaskNode: - -flyteidl.core.TaskNode ----------------------- - -`[flyteidl.core.TaskNode proto] `_ - -Refers to the task that the Node is to execute. - -.. code-block:: json - - { - "reference_id": "{...}" - } - -.. _api_field_flyteidl.core.TaskNode.reference_id: - -reference_id - (:ref:`flyteidl.core.Identifier `) A globally unique identifier for the task. - - - - - -.. _api_msg_flyteidl.core.WorkflowNode: - -flyteidl.core.WorkflowNode --------------------------- - -`[flyteidl.core.WorkflowNode proto] `_ - -Refers to a the workflow the node is to execute. - -.. code-block:: json - - { - "launchplan_ref": "{...}", - "sub_workflow_ref": "{...}" - } - -.. _api_field_flyteidl.core.WorkflowNode.launchplan_ref: - -launchplan_ref - (:ref:`flyteidl.core.Identifier `) A globally unique identifier for the launch plan. - - - - Only one of :ref:`launchplan_ref `, :ref:`sub_workflow_ref ` may be set. - -.. _api_field_flyteidl.core.WorkflowNode.sub_workflow_ref: - -sub_workflow_ref - (:ref:`flyteidl.core.Identifier `) Reference to a subworkflow, that should be defined with the compiler context - - - - Only one of :ref:`launchplan_ref `, :ref:`sub_workflow_ref ` may be set. - - - -.. _api_msg_flyteidl.core.NodeMetadata: - -flyteidl.core.NodeMetadata --------------------------- - -`[flyteidl.core.NodeMetadata proto] `_ - -Defines extra information about the Node. - -.. code-block:: json - - { - "name": "...", - "timeout": "{...}", - "retries": "{...}", - "interruptible": "..." - } - -.. _api_field_flyteidl.core.NodeMetadata.name: - -name - (`string `_) A friendly name for the Node - - -.. _api_field_flyteidl.core.NodeMetadata.timeout: - -timeout - (:ref:`google.protobuf.Duration `) The overall timeout of a task. - - -.. _api_field_flyteidl.core.NodeMetadata.retries: - -retries - (:ref:`flyteidl.core.RetryStrategy `) Number of retries per task. - - -.. _api_field_flyteidl.core.NodeMetadata.interruptible: - -interruptible - (`bool `_) - Identify whether node is interruptible - - - - -.. _api_msg_flyteidl.core.Alias: - -flyteidl.core.Alias -------------------- - -`[flyteidl.core.Alias proto] `_ - -Links a variable to an alias. - -.. code-block:: json - - { - "var": "...", - "alias": "..." - } - -.. _api_field_flyteidl.core.Alias.var: - -var - (`string `_) Must match one of the output variable names on a node. - - -.. _api_field_flyteidl.core.Alias.alias: - -alias - (`string `_) A workflow-level unique alias that downstream nodes can refer to in their input. - - - - -.. _api_msg_flyteidl.core.Node: - -flyteidl.core.Node ------------------- - -`[flyteidl.core.Node proto] `_ - -A Workflow graph Node. One unit of execution in the graph. Each node can be linked to a Task, a Workflow or a branch -node. - -.. code-block:: json - - { - "id": "...", - "metadata": "{...}", - "inputs": [], - "upstream_node_ids": [], - "output_aliases": [], - "task_node": "{...}", - "workflow_node": "{...}", - "branch_node": "{...}" - } - -.. _api_field_flyteidl.core.Node.id: - -id - (`string `_) A workflow-level unique identifier that identifies this node in the workflow. "inputs" and "outputs" are reserved - node ids that cannot be used by other nodes. - - -.. _api_field_flyteidl.core.Node.metadata: - -metadata - (:ref:`flyteidl.core.NodeMetadata `) Extra metadata about the node. - - -.. _api_field_flyteidl.core.Node.inputs: - -inputs - (:ref:`flyteidl.core.Binding `) Specifies how to bind the underlying interface's inputs. All required inputs specified in the underlying interface - must be fullfilled. - - -.. _api_field_flyteidl.core.Node.upstream_node_ids: - -upstream_node_ids - (`string `_) optional Specifies execution depdendency for this node ensuring it will only get scheduled to run after all its - upstream nodes have completed. This node will have an implicit depdendency on any node that appears in inputs - field. - - -.. _api_field_flyteidl.core.Node.output_aliases: - -output_aliases - (:ref:`flyteidl.core.Alias `) optional. A node can define aliases for a subset of its outputs. This is particularly useful if different nodes - need to conform to the same interface (e.g. all branches in a branch node). Downstream nodes must refer to this - nodes outputs using the alias if one's specified. - - -.. _api_field_flyteidl.core.Node.task_node: - -task_node - (:ref:`flyteidl.core.TaskNode `) Information about the Task to execute in this node. - - Information about the target to execute in this node. - - - Only one of :ref:`task_node `, :ref:`workflow_node `, :ref:`branch_node ` may be set. - -.. _api_field_flyteidl.core.Node.workflow_node: - -workflow_node - (:ref:`flyteidl.core.WorkflowNode `) Information about the Workflow to execute in this mode. - - Information about the target to execute in this node. - - - Only one of :ref:`task_node `, :ref:`workflow_node `, :ref:`branch_node ` may be set. - -.. _api_field_flyteidl.core.Node.branch_node: - -branch_node - (:ref:`flyteidl.core.BranchNode `) Information about the branch node to evaluate in this node. - - Information about the target to execute in this node. - - - Only one of :ref:`task_node `, :ref:`workflow_node `, :ref:`branch_node ` may be set. - - - -.. _api_msg_flyteidl.core.WorkflowMetadata: - -flyteidl.core.WorkflowMetadata ------------------------------- - -`[flyteidl.core.WorkflowMetadata proto] `_ - -This is workflow layer metadata. These settings are only applicable to the workflow as a whole, and do not -percolate down to child entities (like tasks) launched by the workflow. - -.. code-block:: json - - { - "quality_of_service": "{...}", - "on_failure": "..." - } - -.. _api_field_flyteidl.core.WorkflowMetadata.quality_of_service: - -quality_of_service - (:ref:`flyteidl.core.QualityOfService `) Indicates the runtime priority of workflow executions. - - -.. _api_field_flyteidl.core.WorkflowMetadata.on_failure: - -on_failure - (:ref:`flyteidl.core.WorkflowMetadata.OnFailurePolicy `) Defines how the system should behave when a failure is detected in the workflow execution. - - - -.. _api_enum_flyteidl.core.WorkflowMetadata.OnFailurePolicy: - -Enum flyteidl.core.WorkflowMetadata.OnFailurePolicy ---------------------------------------------------- - -`[flyteidl.core.WorkflowMetadata.OnFailurePolicy proto] `_ - -Failure Handling Strategy - -.. _api_enum_value_flyteidl.core.WorkflowMetadata.OnFailurePolicy.FAIL_IMMEDIATELY: - -FAIL_IMMEDIATELY - *(DEFAULT)* ⁣FAIL_IMMEDIATELY instructs the system to fail as soon as a node fails in the workflow. It'll automatically - abort all currently running nodes and clean up resources before finally marking the workflow executions as - failed. - - -.. _api_enum_value_flyteidl.core.WorkflowMetadata.OnFailurePolicy.FAIL_AFTER_EXECUTABLE_NODES_COMPLETE: - -FAIL_AFTER_EXECUTABLE_NODES_COMPLETE - ⁣FAIL_AFTER_EXECUTABLE_NODES_COMPLETE instructs the system to make as much progress as it can. The system will - not alter the dependencies of the execution graph so any node that depend on the failed node will not be run. - Other nodes that will be executed to completion before cleaning up resources and marking the workflow - execution as failed. - - - -.. _api_msg_flyteidl.core.WorkflowMetadataDefaults: - -flyteidl.core.WorkflowMetadataDefaults --------------------------------------- - -`[flyteidl.core.WorkflowMetadataDefaults proto] `_ - -The difference between these settings and the WorkflowMetadata ones is that these are meant to be passed down to -a workflow's underlying entities (like tasks). For instance, 'interruptible' has no meaning at the workflow layer, it -is only relevant when a task executes. The settings here are the defaults that are passed to all nodes -unless explicitly overridden at the node layer. -If you are adding a setting that applies to both the Workflow itself, and everything underneath it, it should be -added to both this object and the WorkflowMetadata object above. - -.. code-block:: json - - { - "interruptible": "..." - } - -.. _api_field_flyteidl.core.WorkflowMetadataDefaults.interruptible: - -interruptible - (`bool `_) Whether child nodes of the workflow are interruptible. - - - - -.. _api_msg_flyteidl.core.WorkflowTemplate: - -flyteidl.core.WorkflowTemplate ------------------------------- - -`[flyteidl.core.WorkflowTemplate proto] `_ - -Flyte Workflow Structure that encapsulates task, branch and subworkflow nodes to form a statically analyzable, -directed acyclic graph. - -.. code-block:: json - - { - "id": "{...}", - "metadata": "{...}", - "interface": "{...}", - "nodes": [], - "outputs": [], - "failure_node": "{...}", - "metadata_defaults": "{...}" - } - -.. _api_field_flyteidl.core.WorkflowTemplate.id: - -id - (:ref:`flyteidl.core.Identifier `) A globally unique identifier for the workflow. - - -.. _api_field_flyteidl.core.WorkflowTemplate.metadata: - -metadata - (:ref:`flyteidl.core.WorkflowMetadata `) Extra metadata about the workflow. - - -.. _api_field_flyteidl.core.WorkflowTemplate.interface: - -interface - (:ref:`flyteidl.core.TypedInterface `) Defines a strongly typed interface for the Workflow. This can include some optional parameters. - - -.. _api_field_flyteidl.core.WorkflowTemplate.nodes: - -nodes - (:ref:`flyteidl.core.Node `) A list of nodes. In addition, "globals" is a special reserved node id that can be used to consume workflow inputs. - - -.. _api_field_flyteidl.core.WorkflowTemplate.outputs: - -outputs - (:ref:`flyteidl.core.Binding `) A list of output bindings that specify how to construct workflow outputs. Bindings can pull node outputs or - specify literals. All workflow outputs specified in the interface field must be bound in order for the workflow - to be validated. A workflow has an implicit dependency on all of its nodes to execute successfully in order to - bind final outputs. - Most of these outputs will be Binding's with a BindingData of type OutputReference. That is, your workflow can - just have an output of some constant (`Output(5)`), but usually, the workflow will be pulling - outputs from the output of a task. - - -.. _api_field_flyteidl.core.WorkflowTemplate.failure_node: - -failure_node - (:ref:`flyteidl.core.Node `) optional A catch-all node. This node is executed whenever the execution engine determines the workflow has failed. - The interface of this node must match the Workflow interface with an additional input named "error" of type - pb.lyft.flyte.core.Error. - - -.. _api_field_flyteidl.core.WorkflowTemplate.metadata_defaults: - -metadata_defaults - (:ref:`flyteidl.core.WorkflowMetadataDefaults `) workflow defaults - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/core/workflow_closure.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/core/workflow_closure.proto.rst deleted file mode 100644 index 1f06362d6b..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/core/workflow_closure.proto.rst +++ /dev/null @@ -1,35 +0,0 @@ -.. _api_file_flyteidl/core/workflow_closure.proto: - -workflow_closure.proto -==================================== - -.. _api_msg_flyteidl.core.WorkflowClosure: - -flyteidl.core.WorkflowClosure ------------------------------ - -`[flyteidl.core.WorkflowClosure proto] `_ - -Defines an enclosed package of workflow and tasks it references. - -.. code-block:: json - - { - "workflow": "{...}", - "tasks": [] - } - -.. _api_field_flyteidl.core.WorkflowClosure.workflow: - -workflow - (:ref:`flyteidl.core.WorkflowTemplate `) equired. Workflow template. - - -.. _api_field_flyteidl.core.WorkflowClosure.tasks: - -tasks - (:ref:`flyteidl.core.TaskTemplate `) ptional. A collection of tasks referenced by the workflow. Only needed if the workflow - references tasks. - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/datacatalog/datacatalog.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/datacatalog/datacatalog.proto.rst deleted file mode 100644 index f559f98c1c..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/datacatalog/datacatalog.proto.rst +++ /dev/null @@ -1,1165 +0,0 @@ -.. _api_file_flyteidl/datacatalog/datacatalog.proto: - -datacatalog.proto -====================================== - -.. _api_msg_datacatalog.CreateDatasetRequest: - -datacatalog.CreateDatasetRequest --------------------------------- - -`[datacatalog.CreateDatasetRequest proto] `_ - - -Request message for creating a Dataset. - -.. code-block:: json - - { - "dataset": "{...}" - } - -.. _api_field_datacatalog.CreateDatasetRequest.dataset: - -dataset - (:ref:`datacatalog.Dataset `) - - - -.. _api_msg_datacatalog.CreateDatasetResponse: - -datacatalog.CreateDatasetResponse ---------------------------------- - -`[datacatalog.CreateDatasetResponse proto] `_ - - -Response message for creating a Dataset - -.. code-block:: json - - {} - - - - -.. _api_msg_datacatalog.GetDatasetRequest: - -datacatalog.GetDatasetRequest ------------------------------ - -`[datacatalog.GetDatasetRequest proto] `_ - - -Request message for retrieving a Dataset. The Dataset is retrieved by it's unique identifier -which is a combination of several fields. - -.. code-block:: json - - { - "dataset": "{...}" - } - -.. _api_field_datacatalog.GetDatasetRequest.dataset: - -dataset - (:ref:`datacatalog.DatasetID `) - - - -.. _api_msg_datacatalog.GetDatasetResponse: - -datacatalog.GetDatasetResponse ------------------------------- - -`[datacatalog.GetDatasetResponse proto] `_ - - -Response message for retrieving a Dataset. The response will include the metadata for the -Dataset. - -.. code-block:: json - - { - "dataset": "{...}" - } - -.. _api_field_datacatalog.GetDatasetResponse.dataset: - -dataset - (:ref:`datacatalog.Dataset `) - - - -.. _api_msg_datacatalog.GetArtifactRequest: - -datacatalog.GetArtifactRequest ------------------------------- - -`[datacatalog.GetArtifactRequest proto] `_ - - -Request message for retrieving an Artifact. Retrieve an artifact based on a query handle that -can be one of artifact_id or tag. The result returned will include the artifact data and metadata -associated with the artifact. - -.. code-block:: json - - { - "dataset": "{...}", - "artifact_id": "...", - "tag_name": "..." - } - -.. _api_field_datacatalog.GetArtifactRequest.dataset: - -dataset - (:ref:`datacatalog.DatasetID `) - -.. _api_field_datacatalog.GetArtifactRequest.artifact_id: - -artifact_id - (`string `_) - - - Only one of :ref:`artifact_id `, :ref:`tag_name ` may be set. - -.. _api_field_datacatalog.GetArtifactRequest.tag_name: - -tag_name - (`string `_) - - - Only one of :ref:`artifact_id `, :ref:`tag_name ` may be set. - - - -.. _api_msg_datacatalog.GetArtifactResponse: - -datacatalog.GetArtifactResponse -------------------------------- - -`[datacatalog.GetArtifactResponse proto] `_ - - -Response message for retrieving an Artifact. The result returned will include the artifact data -and metadata associated with the artifact. - -.. code-block:: json - - { - "artifact": "{...}" - } - -.. _api_field_datacatalog.GetArtifactResponse.artifact: - -artifact - (:ref:`datacatalog.Artifact `) - - - -.. _api_msg_datacatalog.CreateArtifactRequest: - -datacatalog.CreateArtifactRequest ---------------------------------- - -`[datacatalog.CreateArtifactRequest proto] `_ - - -Request message for creating an Artifact and its associated artifact Data. - -.. code-block:: json - - { - "artifact": "{...}" - } - -.. _api_field_datacatalog.CreateArtifactRequest.artifact: - -artifact - (:ref:`datacatalog.Artifact `) - - - -.. _api_msg_datacatalog.CreateArtifactResponse: - -datacatalog.CreateArtifactResponse ----------------------------------- - -`[datacatalog.CreateArtifactResponse proto] `_ - - -Response message for creating an Artifact. - -.. code-block:: json - - {} - - - - -.. _api_msg_datacatalog.AddTagRequest: - -datacatalog.AddTagRequest -------------------------- - -`[datacatalog.AddTagRequest proto] `_ - - -Request message for tagging an Artifact. - -.. code-block:: json - - { - "tag": "{...}" - } - -.. _api_field_datacatalog.AddTagRequest.tag: - -tag - (:ref:`datacatalog.Tag `) - - - -.. _api_msg_datacatalog.AddTagResponse: - -datacatalog.AddTagResponse --------------------------- - -`[datacatalog.AddTagResponse proto] `_ - - -Response message for tagging an Artifact. - -.. code-block:: json - - {} - - - - -.. _api_msg_datacatalog.ListArtifactsRequest: - -datacatalog.ListArtifactsRequest --------------------------------- - -`[datacatalog.ListArtifactsRequest proto] `_ - -List the artifacts that belong to the Dataset, optionally filtered using filtered expression. - -.. code-block:: json - - { - "dataset": "{...}", - "filter": "{...}", - "pagination": "{...}" - } - -.. _api_field_datacatalog.ListArtifactsRequest.dataset: - -dataset - (:ref:`datacatalog.DatasetID `) Use a datasetID for which you want to retrieve the artifacts - - -.. _api_field_datacatalog.ListArtifactsRequest.filter: - -filter - (:ref:`datacatalog.FilterExpression `) Apply the filter expression to this query - - -.. _api_field_datacatalog.ListArtifactsRequest.pagination: - -pagination - (:ref:`datacatalog.PaginationOptions `) Pagination options to get a page of artifacts - - - - -.. _api_msg_datacatalog.ListArtifactsResponse: - -datacatalog.ListArtifactsResponse ---------------------------------- - -`[datacatalog.ListArtifactsResponse proto] `_ - -Response to list artifacts - -.. code-block:: json - - { - "artifacts": [], - "next_token": "..." - } - -.. _api_field_datacatalog.ListArtifactsResponse.artifacts: - -artifacts - (:ref:`datacatalog.Artifact `) The list of artifacts - - -.. _api_field_datacatalog.ListArtifactsResponse.next_token: - -next_token - (`string `_) Token to use to request the next page, pass this into the next requests PaginationOptions - - - - -.. _api_msg_datacatalog.ListDatasetsRequest: - -datacatalog.ListDatasetsRequest -------------------------------- - -`[datacatalog.ListDatasetsRequest proto] `_ - -List the datasets for the given query - -.. code-block:: json - - { - "filter": "{...}", - "pagination": "{...}" - } - -.. _api_field_datacatalog.ListDatasetsRequest.filter: - -filter - (:ref:`datacatalog.FilterExpression `) Apply the filter expression to this query - - -.. _api_field_datacatalog.ListDatasetsRequest.pagination: - -pagination - (:ref:`datacatalog.PaginationOptions `) Pagination options to get a page of datasets - - - - -.. _api_msg_datacatalog.ListDatasetsResponse: - -datacatalog.ListDatasetsResponse --------------------------------- - -`[datacatalog.ListDatasetsResponse proto] `_ - -List the datasets response with token for next pagination - -.. code-block:: json - - { - "datasets": [], - "next_token": "..." - } - -.. _api_field_datacatalog.ListDatasetsResponse.datasets: - -datasets - (:ref:`datacatalog.Dataset `) The list of datasets - - -.. _api_field_datacatalog.ListDatasetsResponse.next_token: - -next_token - (`string `_) Token to use to request the next page, pass this into the next requests PaginationOptions - - - - -.. _api_msg_datacatalog.GetOrReserveArtifactRequest: - -datacatalog.GetOrReserveArtifactRequest ---------------------------------------- - -`[datacatalog.GetOrReserveArtifactRequest proto] `_ - -Get the Artifact or try to reserve a spot if the Artifact does not exist. - -.. code-block:: json - - { - "dataset_id": "{...}", - "tag_name": "...", - "owner_id": "..." - } - -.. _api_field_datacatalog.GetOrReserveArtifactRequest.dataset_id: - -dataset_id - (:ref:`datacatalog.DatasetID `) - -.. _api_field_datacatalog.GetOrReserveArtifactRequest.tag_name: - -tag_name - (`string `_) - -.. _api_field_datacatalog.GetOrReserveArtifactRequest.owner_id: - -owner_id - (`string `_) - - - -.. _api_msg_datacatalog.ReservationStatus: - -datacatalog.ReservationStatus ------------------------------ - -`[datacatalog.ReservationStatus proto] `_ - -Whether we successfully reserve a spot. - -.. code-block:: json - - { - "state": "...", - "metadata": "{...}", - "owner_id": "..." - } - -.. _api_field_datacatalog.ReservationStatus.state: - -state - (:ref:`datacatalog.ReservationStatus.State `) - -.. _api_field_datacatalog.ReservationStatus.metadata: - -metadata - (:ref:`datacatalog.Metadata `) - -.. _api_field_datacatalog.ReservationStatus.owner_id: - -owner_id - (`string `_) - - -.. _api_enum_datacatalog.ReservationStatus.State: - -Enum datacatalog.ReservationStatus.State ----------------------------------------- - -`[datacatalog.ReservationStatus.State proto] `_ - - -.. _api_enum_value_datacatalog.ReservationStatus.State.ACQUIRED: - -ACQUIRED - *(DEFAULT)* ⁣Acquired the reservation successfully. - - -.. _api_enum_value_datacatalog.ReservationStatus.State.ALREADY_IN_PROGRESS: - -ALREADY_IN_PROGRESS - ⁣Indicates an existing active reservation exist for a different owner_id. - - - -.. _api_msg_datacatalog.GetOrReserveArtifactResponse: - -datacatalog.GetOrReserveArtifactResponse ----------------------------------------- - -`[datacatalog.GetOrReserveArtifactResponse proto] `_ - -Response to get artifact or reserve spot. - -.. code-block:: json - - { - "artifact": "{...}", - "reservation_status": "{...}" - } - -.. _api_field_datacatalog.GetOrReserveArtifactResponse.artifact: - -artifact - (:ref:`datacatalog.Artifact `) - - - Only one of :ref:`artifact `, :ref:`reservation_status ` may be set. - -.. _api_field_datacatalog.GetOrReserveArtifactResponse.reservation_status: - -reservation_status - (:ref:`datacatalog.ReservationStatus `) - - - Only one of :ref:`artifact `, :ref:`reservation_status ` may be set. - - - -.. _api_msg_datacatalog.ExtendReservationRequest: - -datacatalog.ExtendReservationRequest ------------------------------------- - -`[datacatalog.ExtendReservationRequest proto] `_ - -Request to extend reservation - -.. code-block:: json - - { - "dataset_id": "{...}", - "tag_name": "...", - "owner_id": "..." - } - -.. _api_field_datacatalog.ExtendReservationRequest.dataset_id: - -dataset_id - (:ref:`datacatalog.DatasetID `) - -.. _api_field_datacatalog.ExtendReservationRequest.tag_name: - -tag_name - (`string `_) - -.. _api_field_datacatalog.ExtendReservationRequest.owner_id: - -owner_id - (`string `_) - - - -.. _api_msg_datacatalog.ExtendReservationResponse: - -datacatalog.ExtendReservationResponse -------------------------------------- - -`[datacatalog.ExtendReservationResponse proto] `_ - -Response to extend reservation - -.. code-block:: json - - {} - - - - -.. _api_msg_datacatalog.ReleaseReservationRequest: - -datacatalog.ReleaseReservationRequest -------------------------------------- - -`[datacatalog.ReleaseReservationRequest proto] `_ - -Request to release reservation - -.. code-block:: json - - { - "dataset_id": "{...}", - "tag_name": "...", - "owner_id": "..." - } - -.. _api_field_datacatalog.ReleaseReservationRequest.dataset_id: - -dataset_id - (:ref:`datacatalog.DatasetID `) - -.. _api_field_datacatalog.ReleaseReservationRequest.tag_name: - -tag_name - (`string `_) - -.. _api_field_datacatalog.ReleaseReservationRequest.owner_id: - -owner_id - (`string `_) - - - -.. _api_msg_datacatalog.ReleaseReservationResponse: - -datacatalog.ReleaseReservationResponse --------------------------------------- - -`[datacatalog.ReleaseReservationResponse proto] `_ - -Response to release reservation - -.. code-block:: json - - {} - - - - -.. _api_msg_datacatalog.Dataset: - -datacatalog.Dataset -------------------- - -`[datacatalog.Dataset proto] `_ - - -Dataset message. It is uniquely identified by DatasetID. - -.. code-block:: json - - { - "id": "{...}", - "metadata": "{...}", - "partitionKeys": [] - } - -.. _api_field_datacatalog.Dataset.id: - -id - (:ref:`datacatalog.DatasetID `) - -.. _api_field_datacatalog.Dataset.metadata: - -metadata - (:ref:`datacatalog.Metadata `) - -.. _api_field_datacatalog.Dataset.partitionKeys: - -partitionKeys - (`string `_) - - - -.. _api_msg_datacatalog.Partition: - -datacatalog.Partition ---------------------- - -`[datacatalog.Partition proto] `_ - - -An artifact could have multiple partitions and each partition can have an arbitrary string key/value pair - -.. code-block:: json - - { - "key": "...", - "value": "..." - } - -.. _api_field_datacatalog.Partition.key: - -key - (`string `_) - -.. _api_field_datacatalog.Partition.value: - -value - (`string `_) - - - -.. _api_msg_datacatalog.DatasetID: - -datacatalog.DatasetID ---------------------- - -`[datacatalog.DatasetID proto] `_ - - -DatasetID message that is composed of several string fields. - -.. code-block:: json - - { - "project": "...", - "name": "...", - "domain": "...", - "version": "...", - "UUID": "..." - } - -.. _api_field_datacatalog.DatasetID.project: - -project - (`string `_) - -.. _api_field_datacatalog.DatasetID.name: - -name - (`string `_) - -.. _api_field_datacatalog.DatasetID.domain: - -domain - (`string `_) - -.. _api_field_datacatalog.DatasetID.version: - -version - (`string `_) - -.. _api_field_datacatalog.DatasetID.UUID: - -UUID - (`string `_) - - - -.. _api_msg_datacatalog.Artifact: - -datacatalog.Artifact --------------------- - -`[datacatalog.Artifact proto] `_ - - -Artifact message. It is composed of several string fields. - -.. code-block:: json - - { - "id": "...", - "dataset": "{...}", - "data": [], - "metadata": "{...}", - "partitions": [], - "tags": [], - "created_at": "{...}" - } - -.. _api_field_datacatalog.Artifact.id: - -id - (`string `_) - -.. _api_field_datacatalog.Artifact.dataset: - -dataset - (:ref:`datacatalog.DatasetID `) - -.. _api_field_datacatalog.Artifact.data: - -data - (:ref:`datacatalog.ArtifactData `) - -.. _api_field_datacatalog.Artifact.metadata: - -metadata - (:ref:`datacatalog.Metadata `) - -.. _api_field_datacatalog.Artifact.partitions: - -partitions - (:ref:`datacatalog.Partition `) - -.. _api_field_datacatalog.Artifact.tags: - -tags - (:ref:`datacatalog.Tag `) - -.. _api_field_datacatalog.Artifact.created_at: - -created_at - (:ref:`google.protobuf.Timestamp `) - - - -.. _api_msg_datacatalog.ArtifactData: - -datacatalog.ArtifactData ------------------------- - -`[datacatalog.ArtifactData proto] `_ - - -ArtifactData that belongs to an artifact - -.. code-block:: json - - { - "name": "...", - "value": "{...}" - } - -.. _api_field_datacatalog.ArtifactData.name: - -name - (`string `_) - -.. _api_field_datacatalog.ArtifactData.value: - -value - (:ref:`flyteidl.core.Literal `) - - - -.. _api_msg_datacatalog.Tag: - -datacatalog.Tag ---------------- - -`[datacatalog.Tag proto] `_ - - -Tag message that is unique to a Dataset. It is associated to a single artifact and -can be retrieved by name later. - -.. code-block:: json - - { - "name": "...", - "artifact_id": "...", - "dataset": "{...}" - } - -.. _api_field_datacatalog.Tag.name: - -name - (`string `_) - -.. _api_field_datacatalog.Tag.artifact_id: - -artifact_id - (`string `_) - -.. _api_field_datacatalog.Tag.dataset: - -dataset - (:ref:`datacatalog.DatasetID `) - - - -.. _api_msg_datacatalog.Metadata: - -datacatalog.Metadata --------------------- - -`[datacatalog.Metadata proto] `_ - - -Metadata representation for artifacts and datasets - -.. code-block:: json - - { - "key_map": "{...}" - } - -.. _api_field_datacatalog.Metadata.key_map: - -key_map - (map<`string `_, `string `_>) - - - -.. _api_msg_datacatalog.FilterExpression: - -datacatalog.FilterExpression ----------------------------- - -`[datacatalog.FilterExpression proto] `_ - -Filter expression that is composed of a combination of single filters - -.. code-block:: json - - { - "filters": [] - } - -.. _api_field_datacatalog.FilterExpression.filters: - -filters - (:ref:`datacatalog.SinglePropertyFilter `) - - - -.. _api_msg_datacatalog.SinglePropertyFilter: - -datacatalog.SinglePropertyFilter --------------------------------- - -`[datacatalog.SinglePropertyFilter proto] `_ - -A single property to filter on. - -.. code-block:: json - - { - "tag_filter": "{...}", - "partition_filter": "{...}", - "artifact_filter": "{...}", - "dataset_filter": "{...}", - "operator": "..." - } - -.. _api_field_datacatalog.SinglePropertyFilter.tag_filter: - -tag_filter - (:ref:`datacatalog.TagPropertyFilter `) - - - Only one of :ref:`tag_filter `, :ref:`partition_filter `, :ref:`artifact_filter `, :ref:`dataset_filter ` may be set. - -.. _api_field_datacatalog.SinglePropertyFilter.partition_filter: - -partition_filter - (:ref:`datacatalog.PartitionPropertyFilter `) - - - Only one of :ref:`tag_filter `, :ref:`partition_filter `, :ref:`artifact_filter `, :ref:`dataset_filter ` may be set. - -.. _api_field_datacatalog.SinglePropertyFilter.artifact_filter: - -artifact_filter - (:ref:`datacatalog.ArtifactPropertyFilter `) - - - Only one of :ref:`tag_filter `, :ref:`partition_filter `, :ref:`artifact_filter `, :ref:`dataset_filter ` may be set. - -.. _api_field_datacatalog.SinglePropertyFilter.dataset_filter: - -dataset_filter - (:ref:`datacatalog.DatasetPropertyFilter `) - - - Only one of :ref:`tag_filter `, :ref:`partition_filter `, :ref:`artifact_filter `, :ref:`dataset_filter ` may be set. - -.. _api_field_datacatalog.SinglePropertyFilter.operator: - -operator - (:ref:`datacatalog.SinglePropertyFilter.ComparisonOperator `) - - -.. _api_enum_datacatalog.SinglePropertyFilter.ComparisonOperator: - -Enum datacatalog.SinglePropertyFilter.ComparisonOperator --------------------------------------------------------- - -`[datacatalog.SinglePropertyFilter.ComparisonOperator proto] `_ - -as use-cases come up we can add more operators, ex: gte, like, not eq etc. - -.. _api_enum_value_datacatalog.SinglePropertyFilter.ComparisonOperator.EQUALS: - -EQUALS - *(DEFAULT)* ⁣ - - -.. _api_msg_datacatalog.ArtifactPropertyFilter: - -datacatalog.ArtifactPropertyFilter ----------------------------------- - -`[datacatalog.ArtifactPropertyFilter proto] `_ - -Artifact properties we can filter by - -.. code-block:: json - - { - "artifact_id": "..." - } - -.. _api_field_datacatalog.ArtifactPropertyFilter.artifact_id: - -artifact_id - (`string `_) - oneof because we can add more properties in the future - - - - -.. _api_msg_datacatalog.TagPropertyFilter: - -datacatalog.TagPropertyFilter ------------------------------ - -`[datacatalog.TagPropertyFilter proto] `_ - -Tag properties we can filter by - -.. code-block:: json - - { - "tag_name": "..." - } - -.. _api_field_datacatalog.TagPropertyFilter.tag_name: - -tag_name - (`string `_) - - - - -.. _api_msg_datacatalog.PartitionPropertyFilter: - -datacatalog.PartitionPropertyFilter ------------------------------------ - -`[datacatalog.PartitionPropertyFilter proto] `_ - -Partition properties we can filter by - -.. code-block:: json - - { - "key_val": "{...}" - } - -.. _api_field_datacatalog.PartitionPropertyFilter.key_val: - -key_val - (:ref:`datacatalog.KeyValuePair `) - - - - -.. _api_msg_datacatalog.KeyValuePair: - -datacatalog.KeyValuePair ------------------------- - -`[datacatalog.KeyValuePair proto] `_ - - -.. code-block:: json - - { - "key": "...", - "value": "..." - } - -.. _api_field_datacatalog.KeyValuePair.key: - -key - (`string `_) - -.. _api_field_datacatalog.KeyValuePair.value: - -value - (`string `_) - - - -.. _api_msg_datacatalog.DatasetPropertyFilter: - -datacatalog.DatasetPropertyFilter ---------------------------------- - -`[datacatalog.DatasetPropertyFilter proto] `_ - -Dataset properties we can filter by - -.. code-block:: json - - { - "project": "...", - "name": "...", - "domain": "...", - "version": "..." - } - -.. _api_field_datacatalog.DatasetPropertyFilter.project: - -project - (`string `_) - - - Only one of :ref:`project `, :ref:`name `, :ref:`domain `, :ref:`version ` may be set. - -.. _api_field_datacatalog.DatasetPropertyFilter.name: - -name - (`string `_) - - - Only one of :ref:`project `, :ref:`name `, :ref:`domain `, :ref:`version ` may be set. - -.. _api_field_datacatalog.DatasetPropertyFilter.domain: - -domain - (`string `_) - - - Only one of :ref:`project `, :ref:`name `, :ref:`domain `, :ref:`version ` may be set. - -.. _api_field_datacatalog.DatasetPropertyFilter.version: - -version - (`string `_) - - - Only one of :ref:`project `, :ref:`name `, :ref:`domain `, :ref:`version ` may be set. - - - -.. _api_msg_datacatalog.PaginationOptions: - -datacatalog.PaginationOptions ------------------------------ - -`[datacatalog.PaginationOptions proto] `_ - -Pagination options for making list requests - -.. code-block:: json - - { - "limit": "...", - "token": "...", - "sortKey": "...", - "sortOrder": "..." - } - -.. _api_field_datacatalog.PaginationOptions.limit: - -limit - (`uint32 `_) the max number of results to return - - -.. _api_field_datacatalog.PaginationOptions.token: - -token - (`string `_) the token to pass to fetch the next page - - -.. _api_field_datacatalog.PaginationOptions.sortKey: - -sortKey - (:ref:`datacatalog.PaginationOptions.SortKey `) the property that we want to sort the results by - - -.. _api_field_datacatalog.PaginationOptions.sortOrder: - -sortOrder - (:ref:`datacatalog.PaginationOptions.SortOrder `) the sort order of the results - - - -.. _api_enum_datacatalog.PaginationOptions.SortOrder: - -Enum datacatalog.PaginationOptions.SortOrder --------------------------------------------- - -`[datacatalog.PaginationOptions.SortOrder proto] `_ - - -.. _api_enum_value_datacatalog.PaginationOptions.SortOrder.DESCENDING: - -DESCENDING - *(DEFAULT)* ⁣ - -.. _api_enum_value_datacatalog.PaginationOptions.SortOrder.ASCENDING: - -ASCENDING - ⁣ - - -.. _api_enum_datacatalog.PaginationOptions.SortKey: - -Enum datacatalog.PaginationOptions.SortKey ------------------------------------------- - -`[datacatalog.PaginationOptions.SortKey proto] `_ - - -.. _api_enum_value_datacatalog.PaginationOptions.SortKey.CREATION_TIME: - -CREATION_TIME - *(DEFAULT)* ⁣ - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/event/event.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/event/event.proto.rst deleted file mode 100644 index 6e4a1f6a95..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/event/event.proto.rst +++ /dev/null @@ -1,593 +0,0 @@ -.. _api_file_flyteidl/event/event.proto: - -event.proto -========================== - -.. _api_msg_flyteidl.event.WorkflowExecutionEvent: - -flyteidl.event.WorkflowExecutionEvent -------------------------------------- - -`[flyteidl.event.WorkflowExecutionEvent proto] `_ - - -.. code-block:: json - - { - "execution_id": "{...}", - "producer_id": "...", - "phase": "...", - "occurred_at": "{...}", - "output_uri": "...", - "error": "{...}" - } - -.. _api_field_flyteidl.event.WorkflowExecutionEvent.execution_id: - -execution_id - (:ref:`flyteidl.core.WorkflowExecutionIdentifier `) Workflow execution id - - -.. _api_field_flyteidl.event.WorkflowExecutionEvent.producer_id: - -producer_id - (`string `_) the id of the originator (Propeller) of the event - - -.. _api_field_flyteidl.event.WorkflowExecutionEvent.phase: - -phase - (:ref:`flyteidl.core.WorkflowExecution.Phase `) - -.. _api_field_flyteidl.event.WorkflowExecutionEvent.occurred_at: - -occurred_at - (:ref:`google.protobuf.Timestamp `) This timestamp represents when the original event occurred, it is generated - by the executor of the workflow. - - -.. _api_field_flyteidl.event.WorkflowExecutionEvent.output_uri: - -output_uri - (`string `_) URL to the output of the execution, it encodes all the information - including Cloud source provider. ie., s3://... - - - - Only one of :ref:`output_uri `, :ref:`error ` may be set. - -.. _api_field_flyteidl.event.WorkflowExecutionEvent.error: - -error - (:ref:`flyteidl.core.ExecutionError `) Error information for the execution - - - - Only one of :ref:`output_uri `, :ref:`error ` may be set. - - - -.. _api_msg_flyteidl.event.NodeExecutionEvent: - -flyteidl.event.NodeExecutionEvent ---------------------------------- - -`[flyteidl.event.NodeExecutionEvent proto] `_ - - -.. code-block:: json - - { - "id": "{...}", - "producer_id": "...", - "phase": "...", - "occurred_at": "{...}", - "input_uri": "...", - "output_uri": "...", - "error": "{...}", - "workflow_node_metadata": "{...}", - "task_node_metadata": "{...}", - "parent_task_metadata": "{...}", - "parent_node_metadata": "{...}", - "retry_group": "...", - "spec_node_id": "...", - "node_name": "..." - } - -.. _api_field_flyteidl.event.NodeExecutionEvent.id: - -id - (:ref:`flyteidl.core.NodeExecutionIdentifier `) Unique identifier for this node execution - - -.. _api_field_flyteidl.event.NodeExecutionEvent.producer_id: - -producer_id - (`string `_) the id of the originator (Propeller) of the event - - -.. _api_field_flyteidl.event.NodeExecutionEvent.phase: - -phase - (:ref:`flyteidl.core.NodeExecution.Phase `) - -.. _api_field_flyteidl.event.NodeExecutionEvent.occurred_at: - -occurred_at - (:ref:`google.protobuf.Timestamp `) This timestamp represents when the original event occurred, it is generated - by the executor of the node. - - -.. _api_field_flyteidl.event.NodeExecutionEvent.input_uri: - -input_uri - (`string `_) - -.. _api_field_flyteidl.event.NodeExecutionEvent.output_uri: - -output_uri - (`string `_) URL to the output of the execution, it encodes all the information - including Cloud source provider. ie., s3://... - - - - Only one of :ref:`output_uri `, :ref:`error ` may be set. - -.. _api_field_flyteidl.event.NodeExecutionEvent.error: - -error - (:ref:`flyteidl.core.ExecutionError `) Error information for the execution - - - - Only one of :ref:`output_uri `, :ref:`error ` may be set. - -.. _api_field_flyteidl.event.NodeExecutionEvent.workflow_node_metadata: - -workflow_node_metadata - (:ref:`flyteidl.event.WorkflowNodeMetadata `) - Additional metadata to do with this event's node target based - on the node type - - - Only one of :ref:`workflow_node_metadata `, :ref:`task_node_metadata ` may be set. - -.. _api_field_flyteidl.event.NodeExecutionEvent.task_node_metadata: - -task_node_metadata - (:ref:`flyteidl.event.TaskNodeMetadata `) - Additional metadata to do with this event's node target based - on the node type - - - Only one of :ref:`workflow_node_metadata `, :ref:`task_node_metadata ` may be set. - -.. _api_field_flyteidl.event.NodeExecutionEvent.parent_task_metadata: - -parent_task_metadata - (:ref:`flyteidl.event.ParentTaskExecutionMetadata `) [To be deprecated] Specifies which task (if any) launched this node. - - -.. _api_field_flyteidl.event.NodeExecutionEvent.parent_node_metadata: - -parent_node_metadata - (:ref:`flyteidl.event.ParentNodeExecutionMetadata `) Specifies the parent node of the current node execution. Node executions at level zero will not have a parent node. - - -.. _api_field_flyteidl.event.NodeExecutionEvent.retry_group: - -retry_group - (`string `_) Retry group to indicate grouping of nodes by retries - - -.. _api_field_flyteidl.event.NodeExecutionEvent.spec_node_id: - -spec_node_id - (`string `_) Identifier of the node in the original workflow/graph - This maps to value of WorkflowTemplate.nodes[X].id - - -.. _api_field_flyteidl.event.NodeExecutionEvent.node_name: - -node_name - (`string `_) Friendly readable name for the node - - - - -.. _api_msg_flyteidl.event.WorkflowNodeMetadata: - -flyteidl.event.WorkflowNodeMetadata ------------------------------------ - -`[flyteidl.event.WorkflowNodeMetadata proto] `_ - -For Workflow Nodes we need to send information about the workflow that's launched - -.. code-block:: json - - { - "execution_id": "{...}" - } - -.. _api_field_flyteidl.event.WorkflowNodeMetadata.execution_id: - -execution_id - (:ref:`flyteidl.core.WorkflowExecutionIdentifier `) - - - -.. _api_msg_flyteidl.event.TaskNodeMetadata: - -flyteidl.event.TaskNodeMetadata -------------------------------- - -`[flyteidl.event.TaskNodeMetadata proto] `_ - - -.. code-block:: json - - { - "cache_status": "...", - "catalog_key": "{...}", - "dynamic_workflow": "{...}" - } - -.. _api_field_flyteidl.event.TaskNodeMetadata.cache_status: - -cache_status - (:ref:`flyteidl.core.CatalogCacheStatus `) Captures the status of caching for this execution. - - -.. _api_field_flyteidl.event.TaskNodeMetadata.catalog_key: - -catalog_key - (:ref:`flyteidl.core.CatalogMetadata `) This structure carries the catalog artifact information - - -.. _api_field_flyteidl.event.TaskNodeMetadata.dynamic_workflow: - -dynamic_workflow - (:ref:`flyteidl.event.DynamicWorkflowNodeMetadata `) In the case this task launched a dynamic workflow we capture its structure here. - - - - -.. _api_msg_flyteidl.event.DynamicWorkflowNodeMetadata: - -flyteidl.event.DynamicWorkflowNodeMetadata ------------------------------------------- - -`[flyteidl.event.DynamicWorkflowNodeMetadata proto] `_ - -For dynamic workflow nodes we send information about the dynamic workflow definition that gets generated. - -.. code-block:: json - - { - "id": "{...}", - "compiled_workflow": "{...}" - } - -.. _api_field_flyteidl.event.DynamicWorkflowNodeMetadata.id: - -id - (:ref:`flyteidl.core.Identifier `) id represents the unique identifier of the workflow. - - -.. _api_field_flyteidl.event.DynamicWorkflowNodeMetadata.compiled_workflow: - -compiled_workflow - (:ref:`flyteidl.core.CompiledWorkflowClosure `) Represents the compiled representation of the embedded dynamic workflow. - - - - -.. _api_msg_flyteidl.event.ParentTaskExecutionMetadata: - -flyteidl.event.ParentTaskExecutionMetadata ------------------------------------------- - -`[flyteidl.event.ParentTaskExecutionMetadata proto] `_ - - -.. code-block:: json - - { - "id": "{...}" - } - -.. _api_field_flyteidl.event.ParentTaskExecutionMetadata.id: - -id - (:ref:`flyteidl.core.TaskExecutionIdentifier `) - - - -.. _api_msg_flyteidl.event.ParentNodeExecutionMetadata: - -flyteidl.event.ParentNodeExecutionMetadata ------------------------------------------- - -`[flyteidl.event.ParentNodeExecutionMetadata proto] `_ - - -.. code-block:: json - - { - "node_id": "..." - } - -.. _api_field_flyteidl.event.ParentNodeExecutionMetadata.node_id: - -node_id - (`string `_) Unique identifier of the parent node id within the execution - This is value of core.NodeExecutionIdentifier.node_id of the parent node - - - - -.. _api_msg_flyteidl.event.TaskExecutionEvent: - -flyteidl.event.TaskExecutionEvent ---------------------------------- - -`[flyteidl.event.TaskExecutionEvent proto] `_ - -Plugin specific execution event information. For tasks like Python, Hive, Spark, DynamicJob. - -.. code-block:: json - - { - "task_id": "{...}", - "parent_node_execution_id": "{...}", - "retry_attempt": "...", - "phase": "...", - "producer_id": "...", - "logs": [], - "occurred_at": "{...}", - "input_uri": "...", - "output_uri": "...", - "error": "{...}", - "custom_info": "{...}", - "phase_version": "...", - "reason": "...", - "task_type": "...", - "metadata": "{...}" - } - -.. _api_field_flyteidl.event.TaskExecutionEvent.task_id: - -task_id - (:ref:`flyteidl.core.Identifier `) ID of the task. In combination with the retryAttempt this will indicate - the task execution uniquely for a given parent node execution. - - -.. _api_field_flyteidl.event.TaskExecutionEvent.parent_node_execution_id: - -parent_node_execution_id - (:ref:`flyteidl.core.NodeExecutionIdentifier `) A task execution is always kicked off by a node execution, the event consumer - will use the parent_id to relate the task to it's parent node execution - - -.. _api_field_flyteidl.event.TaskExecutionEvent.retry_attempt: - -retry_attempt - (`uint32 `_) retry attempt number for this task, ie., 2 for the second attempt - - -.. _api_field_flyteidl.event.TaskExecutionEvent.phase: - -phase - (:ref:`flyteidl.core.TaskExecution.Phase `) Phase associated with the event - - -.. _api_field_flyteidl.event.TaskExecutionEvent.producer_id: - -producer_id - (`string `_) id of the process that sent this event, mainly for trace debugging - - -.. _api_field_flyteidl.event.TaskExecutionEvent.logs: - -logs - (:ref:`flyteidl.core.TaskLog `) log information for the task execution - - -.. _api_field_flyteidl.event.TaskExecutionEvent.occurred_at: - -occurred_at - (:ref:`google.protobuf.Timestamp `) This timestamp represents when the original event occurred, it is generated - by the executor of the task. - - -.. _api_field_flyteidl.event.TaskExecutionEvent.input_uri: - -input_uri - (`string `_) URI of the input file, it encodes all the information - including Cloud source provider. ie., s3://... - - -.. _api_field_flyteidl.event.TaskExecutionEvent.output_uri: - -output_uri - (`string `_) URI to the output of the execution, it will be in a format that encodes all the information - including Cloud source provider. ie., s3://... - - - - Only one of :ref:`output_uri `, :ref:`error ` may be set. - -.. _api_field_flyteidl.event.TaskExecutionEvent.error: - -error - (:ref:`flyteidl.core.ExecutionError `) Error information for the execution - - - - Only one of :ref:`output_uri `, :ref:`error ` may be set. - -.. _api_field_flyteidl.event.TaskExecutionEvent.custom_info: - -custom_info - (:ref:`google.protobuf.Struct `) Custom data that the task plugin sends back. This is extensible to allow various plugins in the system. - - -.. _api_field_flyteidl.event.TaskExecutionEvent.phase_version: - -phase_version - (`uint32 `_) Some phases, like RUNNING, can send multiple events with changed metadata (new logs, additional custom_info, etc) - that should be recorded regardless of the lack of phase change. - The version field should be incremented when metadata changes across the duration of an individual phase. - - -.. _api_field_flyteidl.event.TaskExecutionEvent.reason: - -reason - (`string `_) An optional explanation for the phase transition. - - -.. _api_field_flyteidl.event.TaskExecutionEvent.task_type: - -task_type - (`string `_) A predefined yet extensible Task type identifier. If the task definition is already registered in flyte admin - this type will be identical, but not all task executions necessarily use pre-registered definitions and this - type is useful to render the task in the UI, filter task executions, etc. - - -.. _api_field_flyteidl.event.TaskExecutionEvent.metadata: - -metadata - (:ref:`flyteidl.event.TaskExecutionMetadata `) Metadata around how a task was executed. - - - - -.. _api_msg_flyteidl.event.ExternalResourceInfo: - -flyteidl.event.ExternalResourceInfo ------------------------------------ - -`[flyteidl.event.ExternalResourceInfo proto] `_ - -This message contains metadata about external resources produced or used by a specific task execution. - -.. code-block:: json - - { - "external_id": "..." - } - -.. _api_field_flyteidl.event.ExternalResourceInfo.external_id: - -external_id - (`string `_) Identifier for an external resource created by this task execution, for example Qubole query ID or presto query ids. - - - - -.. _api_msg_flyteidl.event.ResourcePoolInfo: - -flyteidl.event.ResourcePoolInfo -------------------------------- - -`[flyteidl.event.ResourcePoolInfo proto] `_ - -This message holds task execution metadata specific to resource allocation used to manage concurrent -executions for a project namespace. - -.. code-block:: json - - { - "allocation_token": "...", - "namespace": "..." - } - -.. _api_field_flyteidl.event.ResourcePoolInfo.allocation_token: - -allocation_token - (`string `_) Unique resource ID used to identify this execution when allocating a token. - - -.. _api_field_flyteidl.event.ResourcePoolInfo.namespace: - -namespace - (`string `_) Namespace under which this task execution requested an allocation token. - - - - -.. _api_msg_flyteidl.event.TaskExecutionMetadata: - -flyteidl.event.TaskExecutionMetadata ------------------------------------- - -`[flyteidl.event.TaskExecutionMetadata proto] `_ - -Holds metadata around how a task was executed. -As a task transitions across event phases during execution some attributes, such its generated name, generated external resources, -and more may grow in size but not change necessarily based on the phase transition that sparked the event update. -Metadata is a container for these attributes across the task execution lifecycle. - -.. code-block:: json - - { - "generated_name": "...", - "external_resources": [], - "resource_pool_info": [], - "plugin_identifier": "...", - "instance_class": "..." - } - -.. _api_field_flyteidl.event.TaskExecutionMetadata.generated_name: - -generated_name - (`string `_) Unique, generated name for this task execution used by the backend. - - -.. _api_field_flyteidl.event.TaskExecutionMetadata.external_resources: - -external_resources - (:ref:`flyteidl.event.ExternalResourceInfo `) Additional data on external resources on other back-ends or platforms (e.g. Hive, Qubole, etc) launched by this task execution. - - -.. _api_field_flyteidl.event.TaskExecutionMetadata.resource_pool_info: - -resource_pool_info - (:ref:`flyteidl.event.ResourcePoolInfo `) Includes additional data on concurrent resource management used during execution.. - This is a repeated field because a plugin can request multiple resource allocations during execution. - - -.. _api_field_flyteidl.event.TaskExecutionMetadata.plugin_identifier: - -plugin_identifier - (`string `_) The identifier of the plugin used to execute this task. - - -.. _api_field_flyteidl.event.TaskExecutionMetadata.instance_class: - -instance_class - (:ref:`flyteidl.event.TaskExecutionMetadata.InstanceClass `) - - -.. _api_enum_flyteidl.event.TaskExecutionMetadata.InstanceClass: - -Enum flyteidl.event.TaskExecutionMetadata.InstanceClass -------------------------------------------------------- - -`[flyteidl.event.TaskExecutionMetadata.InstanceClass proto] `_ - -Includes the broad cateogry of machine used for this specific task execution. - -.. _api_enum_value_flyteidl.event.TaskExecutionMetadata.InstanceClass.DEFAULT: - -DEFAULT - *(DEFAULT)* ⁣The default instance class configured for the flyte application platform. - - -.. _api_enum_value_flyteidl.event.TaskExecutionMetadata.InstanceClass.INTERRUPTIBLE: - -INTERRUPTIBLE - ⁣The instance class configured for interruptible tasks. - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/plugins/array_job.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/plugins/array_job.proto.rst deleted file mode 100644 index 21118e61bd..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/plugins/array_job.proto.rst +++ /dev/null @@ -1,62 +0,0 @@ -.. _api_file_flyteidl/plugins/array_job.proto: - -array_job.proto -================================ - -.. _api_msg_flyteidl.plugins.ArrayJob: - -flyteidl.plugins.ArrayJob -------------------------- - -`[flyteidl.plugins.ArrayJob proto] `_ - -Describes a job that can process independent pieces of data concurrently. Multiple copies of the runnable component -will be executed concurrently. - -.. code-block:: json - - { - "parallelism": "...", - "size": "...", - "min_successes": "...", - "min_success_ratio": "..." - } - -.. _api_field_flyteidl.plugins.ArrayJob.parallelism: - -parallelism - (`int64 `_) Defines the minimum number of instances to bring up concurrently at any given point. Note that this is an - optimistic restriction and that, due to network partitioning or other failures, the actual number of currently - running instances might be more. This has to be a positive number if assigned. Default value is size. - - -.. _api_field_flyteidl.plugins.ArrayJob.size: - -size - (`int64 `_) Defines the number of instances to launch at most. This number should match the size of the input if the job - requires processing of all input data. This has to be a positive number. - In the case this is not defined, the back-end will determine the size at run-time by reading the inputs. - - -.. _api_field_flyteidl.plugins.ArrayJob.min_successes: - -min_successes - (`int64 `_) An absolute number of the minimum number of successful completions of subtasks. As soon as this criteria is met, - the array job will be marked as successful and outputs will be computed. This has to be a non-negative number if - assigned. Default value is size (if specified). - - - - Only one of :ref:`min_successes `, :ref:`min_success_ratio ` may be set. - -.. _api_field_flyteidl.plugins.ArrayJob.min_success_ratio: - -min_success_ratio - (`float `_) If the array job size is not known beforehand, the min_success_ratio can instead be used to determine when an array - job can be marked successful. - - - - Only one of :ref:`min_successes `, :ref:`min_success_ratio ` may be set. - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/plugins/index.rst b/flyteidl/gen/pb-protodoc/flyteidl/plugins/index.rst deleted file mode 100644 index 7cb2db6f76..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/plugins/index.rst +++ /dev/null @@ -1,21 +0,0 @@ -Flyte Task Plugins -================== - -These protocol buffer specifications provide information about the various Task -Plugins available in the Flyte system. - - -.. toctree:: - :maxdepth: 1 - :caption: plugins - :name: pluginstoc - - sagemaker/index - array_job.proto - presto.proto - pytorch.proto - qubole.proto - sidecar.proto - spark.proto - tensorflow.proto - waitable.proto diff --git a/flyteidl/gen/pb-protodoc/flyteidl/plugins/presto.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/plugins/presto.proto.rst deleted file mode 100644 index f91c0c32e3..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/plugins/presto.proto.rst +++ /dev/null @@ -1,45 +0,0 @@ -.. _api_file_flyteidl/plugins/presto.proto: - -presto.proto -============================= - -.. _api_msg_flyteidl.plugins.PrestoQuery: - -flyteidl.plugins.PrestoQuery ----------------------------- - -`[flyteidl.plugins.PrestoQuery proto] `_ - -This message works with the 'presto' task type in the SDK and is the object that will be in the 'custom' field -of a Presto task's TaskTemplate - -.. code-block:: json - - { - "routing_group": "...", - "catalog": "...", - "schema": "...", - "statement": "..." - } - -.. _api_field_flyteidl.plugins.PrestoQuery.routing_group: - -routing_group - (`string `_) - -.. _api_field_flyteidl.plugins.PrestoQuery.catalog: - -catalog - (`string `_) - -.. _api_field_flyteidl.plugins.PrestoQuery.schema: - -schema - (`string `_) - -.. _api_field_flyteidl.plugins.PrestoQuery.statement: - -statement - (`string `_) - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/plugins/pytorch.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/plugins/pytorch.proto.rst deleted file mode 100644 index 4448503623..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/plugins/pytorch.proto.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. _api_file_flyteidl/plugins/pytorch.proto: - -pytorch.proto -============================== - -.. _api_msg_flyteidl.plugins.DistributedPyTorchTrainingTask: - -flyteidl.plugins.DistributedPyTorchTrainingTask ------------------------------------------------ - -`[flyteidl.plugins.DistributedPyTorchTrainingTask proto] `_ - -Custom proto for plugin that enables distributed training using https://github.com/kubeflow/pytorch-operator - -.. code-block:: json - - { - "workers": "..." - } - -.. _api_field_flyteidl.plugins.DistributedPyTorchTrainingTask.workers: - -workers - (`int32 `_) number of worker replicas spawned in the cluster for this job - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/plugins/qubole.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/plugins/qubole.proto.rst deleted file mode 100644 index 0750153a1b..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/plugins/qubole.proto.rst +++ /dev/null @@ -1,101 +0,0 @@ -.. _api_file_flyteidl/plugins/qubole.proto: - -qubole.proto -============================= - -.. _api_msg_flyteidl.plugins.HiveQuery: - -flyteidl.plugins.HiveQuery --------------------------- - -`[flyteidl.plugins.HiveQuery proto] `_ - -Defines a query to execute on a hive cluster. - -.. code-block:: json - - { - "query": "...", - "timeout_sec": "...", - "retryCount": "..." - } - -.. _api_field_flyteidl.plugins.HiveQuery.query: - -query - (`string `_) - -.. _api_field_flyteidl.plugins.HiveQuery.timeout_sec: - -timeout_sec - (`uint32 `_) - -.. _api_field_flyteidl.plugins.HiveQuery.retryCount: - -retryCount - (`uint32 `_) - - - -.. _api_msg_flyteidl.plugins.HiveQueryCollection: - -flyteidl.plugins.HiveQueryCollection ------------------------------------- - -`[flyteidl.plugins.HiveQueryCollection proto] `_ - -Defines a collection of hive queries. - -.. code-block:: json - - { - "queries": [] - } - -.. _api_field_flyteidl.plugins.HiveQueryCollection.queries: - -queries - (:ref:`flyteidl.plugins.HiveQuery `) - - - -.. _api_msg_flyteidl.plugins.QuboleHiveJob: - -flyteidl.plugins.QuboleHiveJob ------------------------------- - -`[flyteidl.plugins.QuboleHiveJob proto] `_ - -This message works with the 'hive' task type in the SDK and is the object that will be in the 'custom' field -of a hive task's TaskTemplate - -.. code-block:: json - - { - "cluster_label": "...", - "query_collection": "{...}", - "tags": [], - "query": "{...}" - } - -.. _api_field_flyteidl.plugins.QuboleHiveJob.cluster_label: - -cluster_label - (`string `_) - -.. _api_field_flyteidl.plugins.QuboleHiveJob.query_collection: - -query_collection - (:ref:`flyteidl.plugins.HiveQueryCollection `) - -.. _api_field_flyteidl.plugins.QuboleHiveJob.tags: - -tags - (`string `_) - -.. _api_field_flyteidl.plugins.QuboleHiveJob.query: - -query - (:ref:`flyteidl.plugins.HiveQuery `) - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/plugins/sagemaker/hyperparameter_tuning_job.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/plugins/sagemaker/hyperparameter_tuning_job.proto.rst deleted file mode 100644 index 59fe2eb72c..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/plugins/sagemaker/hyperparameter_tuning_job.proto.rst +++ /dev/null @@ -1,230 +0,0 @@ -.. _api_file_flyteidl/plugins/sagemaker/hyperparameter_tuning_job.proto: - -hyperparameter_tuning_job.proto -========================================================== - -.. _api_msg_flyteidl.plugins.sagemaker.HyperparameterTuningJob: - -flyteidl.plugins.sagemaker.HyperparameterTuningJob --------------------------------------------------- - -`[flyteidl.plugins.sagemaker.HyperparameterTuningJob proto] `_ - -A pass-through for SageMaker's hyperparameter tuning job - -.. code-block:: json - - { - "training_job": "{...}", - "max_number_of_training_jobs": "...", - "max_parallel_training_jobs": "..." - } - -.. _api_field_flyteidl.plugins.sagemaker.HyperparameterTuningJob.training_job: - -training_job - (:ref:`flyteidl.plugins.sagemaker.TrainingJob `) The underlying training job that the hyperparameter tuning job will launch during the process - - -.. _api_field_flyteidl.plugins.sagemaker.HyperparameterTuningJob.max_number_of_training_jobs: - -max_number_of_training_jobs - (`int64 `_) The maximum number of training jobs that an hpo job can launch. For resource limit purpose. - https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html - - -.. _api_field_flyteidl.plugins.sagemaker.HyperparameterTuningJob.max_parallel_training_jobs: - -max_parallel_training_jobs - (`int64 `_) The maximum number of concurrent training job that an hpo job can launch - https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_ResourceLimits.html - - - - -.. _api_msg_flyteidl.plugins.sagemaker.HyperparameterTuningObjectiveType: - -flyteidl.plugins.sagemaker.HyperparameterTuningObjectiveType ------------------------------------------------------------- - -`[flyteidl.plugins.sagemaker.HyperparameterTuningObjectiveType proto] `_ - -HyperparameterTuningObjectiveType determines the direction of the tuning of the Hyperparameter Tuning Job -with respect to the specified metric. - -.. code-block:: json - - {} - - - -.. _api_enum_flyteidl.plugins.sagemaker.HyperparameterTuningObjectiveType.Value: - -Enum flyteidl.plugins.sagemaker.HyperparameterTuningObjectiveType.Value ------------------------------------------------------------------------ - -`[flyteidl.plugins.sagemaker.HyperparameterTuningObjectiveType.Value proto] `_ - - -.. _api_enum_value_flyteidl.plugins.sagemaker.HyperparameterTuningObjectiveType.Value.MINIMIZE: - -MINIMIZE - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.plugins.sagemaker.HyperparameterTuningObjectiveType.Value.MAXIMIZE: - -MAXIMIZE - ⁣ - - -.. _api_msg_flyteidl.plugins.sagemaker.HyperparameterTuningObjective: - -flyteidl.plugins.sagemaker.HyperparameterTuningObjective --------------------------------------------------------- - -`[flyteidl.plugins.sagemaker.HyperparameterTuningObjective proto] `_ - -The target metric and the objective of the hyperparameter tuning. -https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics.html - -.. code-block:: json - - { - "objective_type": "...", - "metric_name": "..." - } - -.. _api_field_flyteidl.plugins.sagemaker.HyperparameterTuningObjective.objective_type: - -objective_type - (:ref:`flyteidl.plugins.sagemaker.HyperparameterTuningObjectiveType.Value `) HyperparameterTuningObjectiveType determines the direction of the tuning of the Hyperparameter Tuning Job - with respect to the specified metric. - - -.. _api_field_flyteidl.plugins.sagemaker.HyperparameterTuningObjective.metric_name: - -metric_name - (`string `_) The target metric name, which is the user-defined name of the metric specified in the - training job's algorithm specification - - - - -.. _api_msg_flyteidl.plugins.sagemaker.HyperparameterTuningStrategy: - -flyteidl.plugins.sagemaker.HyperparameterTuningStrategy -------------------------------------------------------- - -`[flyteidl.plugins.sagemaker.HyperparameterTuningStrategy proto] `_ - -Setting the strategy used when searching in the hyperparameter space -Refer this doc for more details: -https://aws.amazon.com/blogs/machine-learning/amazon-sagemaker-automatic-model-tuning-now-supports-random-search-and-hyperparameter-scaling/ - -.. code-block:: json - - {} - - - -.. _api_enum_flyteidl.plugins.sagemaker.HyperparameterTuningStrategy.Value: - -Enum flyteidl.plugins.sagemaker.HyperparameterTuningStrategy.Value ------------------------------------------------------------------- - -`[flyteidl.plugins.sagemaker.HyperparameterTuningStrategy.Value proto] `_ - - -.. _api_enum_value_flyteidl.plugins.sagemaker.HyperparameterTuningStrategy.Value.BAYESIAN: - -BAYESIAN - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.plugins.sagemaker.HyperparameterTuningStrategy.Value.RANDOM: - -RANDOM - ⁣ - - -.. _api_msg_flyteidl.plugins.sagemaker.TrainingJobEarlyStoppingType: - -flyteidl.plugins.sagemaker.TrainingJobEarlyStoppingType -------------------------------------------------------- - -`[flyteidl.plugins.sagemaker.TrainingJobEarlyStoppingType proto] `_ - -When the training jobs launched by the hyperparameter tuning job are not improving significantly, -a hyperparameter tuning job can be stopping early. -Note that there's only a subset of built-in algorithms that supports early stopping. -see: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-early-stopping.html - -.. code-block:: json - - {} - - - -.. _api_enum_flyteidl.plugins.sagemaker.TrainingJobEarlyStoppingType.Value: - -Enum flyteidl.plugins.sagemaker.TrainingJobEarlyStoppingType.Value ------------------------------------------------------------------- - -`[flyteidl.plugins.sagemaker.TrainingJobEarlyStoppingType.Value proto] `_ - - -.. _api_enum_value_flyteidl.plugins.sagemaker.TrainingJobEarlyStoppingType.Value.OFF: - -OFF - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.plugins.sagemaker.TrainingJobEarlyStoppingType.Value.AUTO: - -AUTO - ⁣ - - -.. _api_msg_flyteidl.plugins.sagemaker.HyperparameterTuningJobConfig: - -flyteidl.plugins.sagemaker.HyperparameterTuningJobConfig --------------------------------------------------------- - -`[flyteidl.plugins.sagemaker.HyperparameterTuningJobConfig proto] `_ - -The specification of the hyperparameter tuning process -https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-ex-tuning-job.html#automatic-model-tuning-ex-low-tuning-config - -.. code-block:: json - - { - "hyperparameter_ranges": "{...}", - "tuning_strategy": "...", - "tuning_objective": "{...}", - "training_job_early_stopping_type": "..." - } - -.. _api_field_flyteidl.plugins.sagemaker.HyperparameterTuningJobConfig.hyperparameter_ranges: - -hyperparameter_ranges - (:ref:`flyteidl.plugins.sagemaker.ParameterRanges `) ParameterRanges is a map that maps hyperparameter name to the corresponding hyperparameter range - - -.. _api_field_flyteidl.plugins.sagemaker.HyperparameterTuningJobConfig.tuning_strategy: - -tuning_strategy - (:ref:`flyteidl.plugins.sagemaker.HyperparameterTuningStrategy.Value `) Setting the strategy used when searching in the hyperparameter space - - -.. _api_field_flyteidl.plugins.sagemaker.HyperparameterTuningJobConfig.tuning_objective: - -tuning_objective - (:ref:`flyteidl.plugins.sagemaker.HyperparameterTuningObjective `) The target metric and the objective of the hyperparameter tuning. - - -.. _api_field_flyteidl.plugins.sagemaker.HyperparameterTuningJobConfig.training_job_early_stopping_type: - -training_job_early_stopping_type - (:ref:`flyteidl.plugins.sagemaker.TrainingJobEarlyStoppingType.Value `) When the training jobs launched by the hyperparameter tuning job are not improving significantly, - a hyperparameter tuning job can be stopping early. - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/plugins/sagemaker/index.rst b/flyteidl/gen/pb-protodoc/flyteidl/plugins/sagemaker/index.rst deleted file mode 100644 index 667b8213d2..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/plugins/sagemaker/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -sagemaker -========= - -.. toctree:: - :maxdepth: 1 - :caption: sagemaker - :name: sagemakertoc - - hyperparameter_tuning_job.proto - parameter_ranges.proto - training_job.proto diff --git a/flyteidl/gen/pb-protodoc/flyteidl/plugins/sagemaker/parameter_ranges.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/plugins/sagemaker/parameter_ranges.proto.rst deleted file mode 100644 index ab5e14097c..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/plugins/sagemaker/parameter_ranges.proto.rst +++ /dev/null @@ -1,215 +0,0 @@ -.. _api_file_flyteidl/plugins/sagemaker/parameter_ranges.proto: - -parameter_ranges.proto -================================================= - -.. _api_msg_flyteidl.plugins.sagemaker.HyperparameterScalingType: - -flyteidl.plugins.sagemaker.HyperparameterScalingType ----------------------------------------------------- - -`[flyteidl.plugins.sagemaker.HyperparameterScalingType proto] `_ - -HyperparameterScalingType defines the way to increase or decrease the value of the hyperparameter -For details, refer to: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html -See examples of these scaling type, refer to: https://aws.amazon.com/blogs/machine-learning/amazon-sagemaker-automatic-model-tuning-now-supports-random-search-and-hyperparameter-scaling/ - -.. code-block:: json - - {} - - - -.. _api_enum_flyteidl.plugins.sagemaker.HyperparameterScalingType.Value: - -Enum flyteidl.plugins.sagemaker.HyperparameterScalingType.Value ---------------------------------------------------------------- - -`[flyteidl.plugins.sagemaker.HyperparameterScalingType.Value proto] `_ - - -.. _api_enum_value_flyteidl.plugins.sagemaker.HyperparameterScalingType.Value.AUTO: - -AUTO - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.plugins.sagemaker.HyperparameterScalingType.Value.LINEAR: - -LINEAR - ⁣ - -.. _api_enum_value_flyteidl.plugins.sagemaker.HyperparameterScalingType.Value.LOGARITHMIC: - -LOGARITHMIC - ⁣ - -.. _api_enum_value_flyteidl.plugins.sagemaker.HyperparameterScalingType.Value.REVERSELOGARITHMIC: - -REVERSELOGARITHMIC - ⁣ - - -.. _api_msg_flyteidl.plugins.sagemaker.ContinuousParameterRange: - -flyteidl.plugins.sagemaker.ContinuousParameterRange ---------------------------------------------------- - -`[flyteidl.plugins.sagemaker.ContinuousParameterRange proto] `_ - -ContinuousParameterRange refers to a continuous range of hyperparameter values, allowing -users to specify the search space of a floating-point hyperparameter -https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html - -.. code-block:: json - - { - "max_value": "...", - "min_value": "...", - "scaling_type": "..." - } - -.. _api_field_flyteidl.plugins.sagemaker.ContinuousParameterRange.max_value: - -max_value - (`double `_) - -.. _api_field_flyteidl.plugins.sagemaker.ContinuousParameterRange.min_value: - -min_value - (`double `_) - -.. _api_field_flyteidl.plugins.sagemaker.ContinuousParameterRange.scaling_type: - -scaling_type - (:ref:`flyteidl.plugins.sagemaker.HyperparameterScalingType.Value `) - - - -.. _api_msg_flyteidl.plugins.sagemaker.IntegerParameterRange: - -flyteidl.plugins.sagemaker.IntegerParameterRange ------------------------------------------------- - -`[flyteidl.plugins.sagemaker.IntegerParameterRange proto] `_ - -IntegerParameterRange refers to a discrete range of hyperparameter values, allowing -users to specify the search space of an integer hyperparameter -https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html - -.. code-block:: json - - { - "max_value": "...", - "min_value": "...", - "scaling_type": "..." - } - -.. _api_field_flyteidl.plugins.sagemaker.IntegerParameterRange.max_value: - -max_value - (`int64 `_) - -.. _api_field_flyteidl.plugins.sagemaker.IntegerParameterRange.min_value: - -min_value - (`int64 `_) - -.. _api_field_flyteidl.plugins.sagemaker.IntegerParameterRange.scaling_type: - -scaling_type - (:ref:`flyteidl.plugins.sagemaker.HyperparameterScalingType.Value `) - - - -.. _api_msg_flyteidl.plugins.sagemaker.CategoricalParameterRange: - -flyteidl.plugins.sagemaker.CategoricalParameterRange ----------------------------------------------------- - -`[flyteidl.plugins.sagemaker.CategoricalParameterRange proto] `_ - -ContinuousParameterRange refers to a continuous range of hyperparameter values, allowing -users to specify the search space of a floating-point hyperparameter -https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html - -.. code-block:: json - - { - "values": [] - } - -.. _api_field_flyteidl.plugins.sagemaker.CategoricalParameterRange.values: - -values - (`string `_) - - - -.. _api_msg_flyteidl.plugins.sagemaker.ParameterRangeOneOf: - -flyteidl.plugins.sagemaker.ParameterRangeOneOf ----------------------------------------------- - -`[flyteidl.plugins.sagemaker.ParameterRangeOneOf proto] `_ - -ParameterRangeOneOf describes a single ParameterRange, which is a one-of structure that can be one of -the three possible types: ContinuousParameterRange, IntegerParameterRange, and CategoricalParameterRange. -This one-of structure in Flyte enables specifying a Parameter in a type-safe manner -See: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html - -.. code-block:: json - - { - "continuous_parameter_range": "{...}", - "integer_parameter_range": "{...}", - "categorical_parameter_range": "{...}" - } - -.. _api_field_flyteidl.plugins.sagemaker.ParameterRangeOneOf.continuous_parameter_range: - -continuous_parameter_range - (:ref:`flyteidl.plugins.sagemaker.ContinuousParameterRange `) - - - Only one of :ref:`continuous_parameter_range `, :ref:`integer_parameter_range `, :ref:`categorical_parameter_range ` may be set. - -.. _api_field_flyteidl.plugins.sagemaker.ParameterRangeOneOf.integer_parameter_range: - -integer_parameter_range - (:ref:`flyteidl.plugins.sagemaker.IntegerParameterRange `) - - - Only one of :ref:`continuous_parameter_range `, :ref:`integer_parameter_range `, :ref:`categorical_parameter_range ` may be set. - -.. _api_field_flyteidl.plugins.sagemaker.ParameterRangeOneOf.categorical_parameter_range: - -categorical_parameter_range - (:ref:`flyteidl.plugins.sagemaker.CategoricalParameterRange `) - - - Only one of :ref:`continuous_parameter_range `, :ref:`integer_parameter_range `, :ref:`categorical_parameter_range ` may be set. - - - -.. _api_msg_flyteidl.plugins.sagemaker.ParameterRanges: - -flyteidl.plugins.sagemaker.ParameterRanges ------------------------------------------- - -`[flyteidl.plugins.sagemaker.ParameterRanges proto] `_ - -ParameterRanges is a map that maps hyperparameter name to the corresponding hyperparameter range -https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-ranges.html - -.. code-block:: json - - { - "parameter_range_map": "{...}" - } - -.. _api_field_flyteidl.plugins.sagemaker.ParameterRanges.parameter_range_map: - -parameter_range_map - (map<`string `_, :ref:`flyteidl.plugins.sagemaker.ParameterRangeOneOf `>) - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/plugins/sagemaker/training_job.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/plugins/sagemaker/training_job.proto.rst deleted file mode 100644 index 625c9d511c..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/plugins/sagemaker/training_job.proto.rst +++ /dev/null @@ -1,324 +0,0 @@ -.. _api_file_flyteidl/plugins/sagemaker/training_job.proto: - -training_job.proto -============================================= - -.. _api_msg_flyteidl.plugins.sagemaker.InputMode: - -flyteidl.plugins.sagemaker.InputMode ------------------------------------- - -`[flyteidl.plugins.sagemaker.InputMode proto] `_ - -The input mode that the algorithm supports. When using the File input mode, SageMaker downloads -the training data from S3 to the provisioned ML storage Volume, and mounts the directory to docker -volume for training container. When using Pipe input mode, Amazon SageMaker streams data directly -from S3 to the container. -See: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AlgorithmSpecification.html -For the input modes that different SageMaker algorithms support, see: -https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html - -.. code-block:: json - - {} - - - -.. _api_enum_flyteidl.plugins.sagemaker.InputMode.Value: - -Enum flyteidl.plugins.sagemaker.InputMode.Value ------------------------------------------------ - -`[flyteidl.plugins.sagemaker.InputMode.Value proto] `_ - - -.. _api_enum_value_flyteidl.plugins.sagemaker.InputMode.Value.FILE: - -FILE - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.plugins.sagemaker.InputMode.Value.PIPE: - -PIPE - ⁣ - - -.. _api_msg_flyteidl.plugins.sagemaker.AlgorithmName: - -flyteidl.plugins.sagemaker.AlgorithmName ----------------------------------------- - -`[flyteidl.plugins.sagemaker.AlgorithmName proto] `_ - -The algorithm name is used for deciding which pre-built image to point to. -This is only required for use cases where SageMaker's built-in algorithm mode is used. -While we currently only support a subset of the algorithms, more will be added to the list. -See: https://docs.aws.amazon.com/sagemaker/latest/dg/algos.html - -.. code-block:: json - - {} - - - -.. _api_enum_flyteidl.plugins.sagemaker.AlgorithmName.Value: - -Enum flyteidl.plugins.sagemaker.AlgorithmName.Value ---------------------------------------------------- - -`[flyteidl.plugins.sagemaker.AlgorithmName.Value proto] `_ - - -.. _api_enum_value_flyteidl.plugins.sagemaker.AlgorithmName.Value.CUSTOM: - -CUSTOM - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.plugins.sagemaker.AlgorithmName.Value.XGBOOST: - -XGBOOST - ⁣ - - -.. _api_msg_flyteidl.plugins.sagemaker.InputContentType: - -flyteidl.plugins.sagemaker.InputContentType -------------------------------------------- - -`[flyteidl.plugins.sagemaker.InputContentType proto] `_ - -Specifies the type of file for input data. Different SageMaker built-in algorithms require different file types of input data -See https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-training.html -https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html - -.. code-block:: json - - {} - - - -.. _api_enum_flyteidl.plugins.sagemaker.InputContentType.Value: - -Enum flyteidl.plugins.sagemaker.InputContentType.Value ------------------------------------------------------- - -`[flyteidl.plugins.sagemaker.InputContentType.Value proto] `_ - - -.. _api_enum_value_flyteidl.plugins.sagemaker.InputContentType.Value.TEXT_CSV: - -TEXT_CSV - *(DEFAULT)* ⁣ - - -.. _api_msg_flyteidl.plugins.sagemaker.MetricDefinition: - -flyteidl.plugins.sagemaker.MetricDefinition -------------------------------------------- - -`[flyteidl.plugins.sagemaker.MetricDefinition proto] `_ - -Specifies a metric that the training algorithm writes to stderr or stdout. -This object is a pass-through. -See this for details: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_MetricDefinition.html - -.. code-block:: json - - { - "name": "...", - "regex": "..." - } - -.. _api_field_flyteidl.plugins.sagemaker.MetricDefinition.name: - -name - (`string `_) User-defined name of the metric - - -.. _api_field_flyteidl.plugins.sagemaker.MetricDefinition.regex: - -regex - (`string `_) SageMaker hyperparameter tuning parses your algorithm’s stdout and stderr streams to find algorithm metrics - - - - -.. _api_msg_flyteidl.plugins.sagemaker.AlgorithmSpecification: - -flyteidl.plugins.sagemaker.AlgorithmSpecification -------------------------------------------------- - -`[flyteidl.plugins.sagemaker.AlgorithmSpecification proto] `_ - -Specifies the training algorithm to be used in the training job -This object is mostly a pass-through, with a couple of exceptions include: (1) in Flyte, users don't need to specify -TrainingImage; either use the built-in algorithm mode by using Flytekit's Simple Training Job and specifying an algorithm -name and an algorithm version or (2) when users want to supply custom algorithms they should set algorithm_name field to -CUSTOM. In this case, the value of the algorithm_version field has no effect -For pass-through use cases: refer to this AWS official document for more details -https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AlgorithmSpecification.html - -.. code-block:: json - - { - "input_mode": "...", - "algorithm_name": "...", - "algorithm_version": "...", - "metric_definitions": [], - "input_content_type": "..." - } - -.. _api_field_flyteidl.plugins.sagemaker.AlgorithmSpecification.input_mode: - -input_mode - (:ref:`flyteidl.plugins.sagemaker.InputMode.Value `) The input mode can be either PIPE or FILE - - -.. _api_field_flyteidl.plugins.sagemaker.AlgorithmSpecification.algorithm_name: - -algorithm_name - (:ref:`flyteidl.plugins.sagemaker.AlgorithmName.Value `) The algorithm name is used for deciding which pre-built image to point to - - -.. _api_field_flyteidl.plugins.sagemaker.AlgorithmSpecification.algorithm_version: - -algorithm_version - (`string `_) The algorithm version field is used for deciding which pre-built image to point to - This is only needed for use cases where SageMaker's built-in algorithm mode is chosen - - -.. _api_field_flyteidl.plugins.sagemaker.AlgorithmSpecification.metric_definitions: - -metric_definitions - (:ref:`flyteidl.plugins.sagemaker.MetricDefinition `) A list of metric definitions for SageMaker to evaluate/track on the progress of the training job - See this: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_AlgorithmSpecification.html - and this: https://docs.aws.amazon.com/sagemaker/latest/dg/automatic-model-tuning-define-metrics.html - - -.. _api_field_flyteidl.plugins.sagemaker.AlgorithmSpecification.input_content_type: - -input_content_type - (:ref:`flyteidl.plugins.sagemaker.InputContentType.Value `) The content type of the input - See https://docs.aws.amazon.com/sagemaker/latest/dg/cdf-training.html - https://docs.aws.amazon.com/sagemaker/latest/dg/sagemaker-algo-docker-registry-paths.html - - - - -.. _api_msg_flyteidl.plugins.sagemaker.DistributedProtocol: - -flyteidl.plugins.sagemaker.DistributedProtocol ----------------------------------------------- - -`[flyteidl.plugins.sagemaker.DistributedProtocol proto] `_ - -When enabling distributed training on a training job, the user should use this message to tell Flyte and SageMaker -what kind of distributed protocol he/she wants to use to distribute the work. - -.. code-block:: json - - {} - - - -.. _api_enum_flyteidl.plugins.sagemaker.DistributedProtocol.Value: - -Enum flyteidl.plugins.sagemaker.DistributedProtocol.Value ---------------------------------------------------------- - -`[flyteidl.plugins.sagemaker.DistributedProtocol.Value proto] `_ - - -.. _api_enum_value_flyteidl.plugins.sagemaker.DistributedProtocol.Value.UNSPECIFIED: - -UNSPECIFIED - *(DEFAULT)* ⁣Use this value if the user wishes to use framework-native distributed training interfaces. - If this value is used, Flyte won't configure SageMaker to initialize unnecessary components such as - OpenMPI or Parameter Server. - - -.. _api_enum_value_flyteidl.plugins.sagemaker.DistributedProtocol.Value.MPI: - -MPI - ⁣Use this value if the user wishes to use MPI as the underlying protocol for her distributed training job - MPI is a framework-agnostic distributed protocol. It has multiple implementations. Currently, we have only - tested the OpenMPI implementation, which is the recommended implementation for Horovod. - - - -.. _api_msg_flyteidl.plugins.sagemaker.TrainingJobResourceConfig: - -flyteidl.plugins.sagemaker.TrainingJobResourceConfig ----------------------------------------------------- - -`[flyteidl.plugins.sagemaker.TrainingJobResourceConfig proto] `_ - -TrainingJobResourceConfig is a pass-through, specifying the instance type to use for the training job, the -number of instances to launch, and the size of the ML storage volume the user wants to provision -Refer to SageMaker official doc for more details: https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html - -.. code-block:: json - - { - "instance_count": "...", - "instance_type": "...", - "volume_size_in_gb": "...", - "distributed_protocol": "..." - } - -.. _api_field_flyteidl.plugins.sagemaker.TrainingJobResourceConfig.instance_count: - -instance_count - (`int64 `_) The number of ML compute instances to use. For distributed training, provide a value greater than 1. - - -.. _api_field_flyteidl.plugins.sagemaker.TrainingJobResourceConfig.instance_type: - -instance_type - (`string `_) The ML compute instance type - - -.. _api_field_flyteidl.plugins.sagemaker.TrainingJobResourceConfig.volume_size_in_gb: - -volume_size_in_gb - (`int64 `_) The size of the ML storage volume that you want to provision. - - -.. _api_field_flyteidl.plugins.sagemaker.TrainingJobResourceConfig.distributed_protocol: - -distributed_protocol - (:ref:`flyteidl.plugins.sagemaker.DistributedProtocol.Value `) When users specify an instance_count > 1, Flyte will try to configure SageMaker to enable distributed training. - If the users wish to use framework-agnostic distributed protocol such as MPI or Parameter Server, this - field should be set to the corresponding enum value - - - - -.. _api_msg_flyteidl.plugins.sagemaker.TrainingJob: - -flyteidl.plugins.sagemaker.TrainingJob --------------------------------------- - -`[flyteidl.plugins.sagemaker.TrainingJob proto] `_ - -The spec of a training job. This is mostly a pass-through object -https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_CreateTrainingJob.html - -.. code-block:: json - - { - "algorithm_specification": "{...}", - "training_job_resource_config": "{...}" - } - -.. _api_field_flyteidl.plugins.sagemaker.TrainingJob.algorithm_specification: - -algorithm_specification - (:ref:`flyteidl.plugins.sagemaker.AlgorithmSpecification `) - -.. _api_field_flyteidl.plugins.sagemaker.TrainingJob.training_job_resource_config: - -training_job_resource_config - (:ref:`flyteidl.plugins.sagemaker.TrainingJobResourceConfig `) - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/plugins/sidecar.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/plugins/sidecar.proto.rst deleted file mode 100644 index 5a1b645556..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/plugins/sidecar.proto.rst +++ /dev/null @@ -1,34 +0,0 @@ -.. _api_file_flyteidl/plugins/sidecar.proto: - -sidecar.proto -============================== - -.. _api_msg_flyteidl.plugins.SidecarJob: - -flyteidl.plugins.SidecarJob ---------------------------- - -`[flyteidl.plugins.SidecarJob proto] `_ - -A sidecar job brings up the desired pod_spec. -The plugin executor is responsible for keeping the pod alive until the primary container terminates -or the task itself times out. - -.. code-block:: json - - { - "pod_spec": "{...}", - "primary_container_name": "..." - } - -.. _api_field_flyteidl.plugins.SidecarJob.pod_spec: - -pod_spec - (:ref:`k8s.io.api.core.v1.PodSpec `) - -.. _api_field_flyteidl.plugins.SidecarJob.primary_container_name: - -primary_container_name - (`string `_) - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/plugins/spark.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/plugins/spark.proto.rst deleted file mode 100644 index 542de05354..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/plugins/spark.proto.rst +++ /dev/null @@ -1,100 +0,0 @@ -.. _api_file_flyteidl/plugins/spark.proto: - -spark.proto -============================ - -.. _api_msg_flyteidl.plugins.SparkApplication: - -flyteidl.plugins.SparkApplication ---------------------------------- - -`[flyteidl.plugins.SparkApplication proto] `_ - - -.. code-block:: json - - {} - - - -.. _api_enum_flyteidl.plugins.SparkApplication.Type: - -Enum flyteidl.plugins.SparkApplication.Type -------------------------------------------- - -`[flyteidl.plugins.SparkApplication.Type proto] `_ - - -.. _api_enum_value_flyteidl.plugins.SparkApplication.Type.PYTHON: - -PYTHON - *(DEFAULT)* ⁣ - -.. _api_enum_value_flyteidl.plugins.SparkApplication.Type.JAVA: - -JAVA - ⁣ - -.. _api_enum_value_flyteidl.plugins.SparkApplication.Type.SCALA: - -SCALA - ⁣ - -.. _api_enum_value_flyteidl.plugins.SparkApplication.Type.R: - -R - ⁣ - - -.. _api_msg_flyteidl.plugins.SparkJob: - -flyteidl.plugins.SparkJob -------------------------- - -`[flyteidl.plugins.SparkJob proto] `_ - -Custom Proto for Spark Plugin. - -.. code-block:: json - - { - "applicationType": "...", - "mainApplicationFile": "...", - "mainClass": "...", - "sparkConf": "{...}", - "hadoopConf": "{...}", - "executorPath": "..." - } - -.. _api_field_flyteidl.plugins.SparkJob.applicationType: - -applicationType - (:ref:`flyteidl.plugins.SparkApplication.Type `) - -.. _api_field_flyteidl.plugins.SparkJob.mainApplicationFile: - -mainApplicationFile - (`string `_) - -.. _api_field_flyteidl.plugins.SparkJob.mainClass: - -mainClass - (`string `_) - -.. _api_field_flyteidl.plugins.SparkJob.sparkConf: - -sparkConf - (map<`string `_, `string `_>) - -.. _api_field_flyteidl.plugins.SparkJob.hadoopConf: - -hadoopConf - (map<`string `_, `string `_>) - -.. _api_field_flyteidl.plugins.SparkJob.executorPath: - -executorPath - (`string `_) - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/plugins/tensorflow.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/plugins/tensorflow.proto.rst deleted file mode 100644 index 33b9fff669..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/plugins/tensorflow.proto.rst +++ /dev/null @@ -1,40 +0,0 @@ -.. _api_file_flyteidl/plugins/tensorflow.proto: - -tensorflow.proto -================================= - -.. _api_msg_flyteidl.plugins.DistributedTensorflowTrainingTask: - -flyteidl.plugins.DistributedTensorflowTrainingTask --------------------------------------------------- - -`[flyteidl.plugins.DistributedTensorflowTrainingTask proto] `_ - -Custom proto for plugin that enables distributed training using https://github.com/kubeflow/tf-operator - -.. code-block:: json - - { - "workers": "...", - "ps_replicas": "...", - "chief_replicas": "..." - } - -.. _api_field_flyteidl.plugins.DistributedTensorflowTrainingTask.workers: - -workers - (`int32 `_) number of worker, ps, chief replicas spawned in the cluster for this job - - -.. _api_field_flyteidl.plugins.DistributedTensorflowTrainingTask.ps_replicas: - -ps_replicas - (`int32 `_) PS -> Parameter server - - -.. _api_field_flyteidl.plugins.DistributedTensorflowTrainingTask.chief_replicas: - -chief_replicas - (`int32 `_) - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/plugins/waitable.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/plugins/waitable.proto.rst deleted file mode 100644 index 0856223acc..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/plugins/waitable.proto.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. _api_file_flyteidl/plugins/waitable.proto: - -waitable.proto -=============================== - -.. _api_msg_flyteidl.plugins.Waitable: - -flyteidl.plugins.Waitable -------------------------- - -`[flyteidl.plugins.Waitable proto] `_ - -Represents an Execution that was launched and could be waited on. - -.. code-block:: json - - { - "wf_exec_id": "{...}", - "phase": "...", - "workflow_id": "..." - } - -.. _api_field_flyteidl.plugins.Waitable.wf_exec_id: - -wf_exec_id - (:ref:`flyteidl.core.WorkflowExecutionIdentifier `) - -.. _api_field_flyteidl.plugins.Waitable.phase: - -phase - (:ref:`flyteidl.core.WorkflowExecution.Phase `) - -.. _api_field_flyteidl.plugins.Waitable.workflow_id: - -workflow_id - (`string `_) - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/service/admin.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/service/admin.proto.rst deleted file mode 100644 index 1d5dce78f0..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/service/admin.proto.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _api_file_flyteidl/service/admin.proto: - -admin.proto -============================ - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/service/auth.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/service/auth.proto.rst deleted file mode 100644 index 5e1b6f6031..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/service/auth.proto.rst +++ /dev/null @@ -1,163 +0,0 @@ -.. _api_file_flyteidl/service/auth.proto: - -auth.proto -=========================== - -.. _api_msg_flyteidl.service.OAuth2MetadataRequest: - -flyteidl.service.OAuth2MetadataRequest --------------------------------------- - -`[flyteidl.service.OAuth2MetadataRequest proto] `_ - - -.. code-block:: json - - {} - - - - -.. _api_msg_flyteidl.service.OAuth2MetadataResponse: - -flyteidl.service.OAuth2MetadataResponse ---------------------------------------- - -`[flyteidl.service.OAuth2MetadataResponse proto] `_ - -OAuth2MetadataResponse defines an RFC-Compliant response for /.well-known/oauth-authorization-server metadata -as defined in https://tools.ietf.org/html/rfc8414 - -.. code-block:: json - - { - "issuer": "...", - "authorization_endpoint": "...", - "token_endpoint": "...", - "response_types_supported": [], - "scopes_supported": [], - "token_endpoint_auth_methods_supported": [], - "jwks_uri": "...", - "code_challenge_methods_supported": [], - "grant_types_supported": [] - } - -.. _api_field_flyteidl.service.OAuth2MetadataResponse.issuer: - -issuer - (`string `_) Defines the issuer string in all JWT tokens this server issues. The issuer can be admin itself or an external - issuer. - - -.. _api_field_flyteidl.service.OAuth2MetadataResponse.authorization_endpoint: - -authorization_endpoint - (`string `_) URL of the authorization server's authorization endpoint [RFC6749]. This is REQUIRED unless no grant types are - supported that use the authorization endpoint. - - -.. _api_field_flyteidl.service.OAuth2MetadataResponse.token_endpoint: - -token_endpoint - (`string `_) URL of the authorization server's token endpoint [RFC6749]. - - -.. _api_field_flyteidl.service.OAuth2MetadataResponse.response_types_supported: - -response_types_supported - (`string `_) Array containing a list of the OAuth 2.0 "response_type" values that this authorization server supports. - - -.. _api_field_flyteidl.service.OAuth2MetadataResponse.scopes_supported: - -scopes_supported - (`string `_) JSON array containing a list of the OAuth 2.0 [RFC6749] "scope" values that this authorization server supports. - - -.. _api_field_flyteidl.service.OAuth2MetadataResponse.token_endpoint_auth_methods_supported: - -token_endpoint_auth_methods_supported - (`string `_) JSON array containing a list of client authentication methods supported by this token endpoint. - - -.. _api_field_flyteidl.service.OAuth2MetadataResponse.jwks_uri: - -jwks_uri - (`string `_) URL of the authorization server's JWK Set [JWK] document. The referenced document contains the signing key(s) the - client uses to validate signatures from the authorization server. - - -.. _api_field_flyteidl.service.OAuth2MetadataResponse.code_challenge_methods_supported: - -code_challenge_methods_supported - (`string `_) JSON array containing a list of Proof Key for Code Exchange (PKCE) [RFC7636] code challenge methods supported by - this authorization server. - - -.. _api_field_flyteidl.service.OAuth2MetadataResponse.grant_types_supported: - -grant_types_supported - (`string `_) JSON array containing a list of the OAuth 2.0 grant type values that this authorization server supports. - - - - -.. _api_msg_flyteidl.service.PublicClientAuthConfigRequest: - -flyteidl.service.PublicClientAuthConfigRequest ----------------------------------------------- - -`[flyteidl.service.PublicClientAuthConfigRequest proto] `_ - - -.. code-block:: json - - {} - - - - -.. _api_msg_flyteidl.service.PublicClientAuthConfigResponse: - -flyteidl.service.PublicClientAuthConfigResponse ------------------------------------------------ - -`[flyteidl.service.PublicClientAuthConfigResponse proto] `_ - -FlyteClientResponse encapsulates public information that flyte clients (CLIs... etc.) can use to authenticate users. - -.. code-block:: json - - { - "client_id": "...", - "redirect_uri": "...", - "scopes": [], - "authorization_metadata_key": "..." - } - -.. _api_field_flyteidl.service.PublicClientAuthConfigResponse.client_id: - -client_id - (`string `_) client_id to use when initiating OAuth2 authorization requests. - - -.. _api_field_flyteidl.service.PublicClientAuthConfigResponse.redirect_uri: - -redirect_uri - (`string `_) redirect uri to use when initiating OAuth2 authorization requests. - - -.. _api_field_flyteidl.service.PublicClientAuthConfigResponse.scopes: - -scopes - (`string `_) scopes to request when initiating OAuth2 authorization requests. - - -.. _api_field_flyteidl.service.PublicClientAuthConfigResponse.authorization_metadata_key: - -authorization_metadata_key - (`string `_) Authorization Header to use when passing Access Tokens to the server. If not provided, the client should use the - default http `Authorization` header. - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/service/identity.proto.rst b/flyteidl/gen/pb-protodoc/flyteidl/service/identity.proto.rst deleted file mode 100644 index cac12657ee..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/service/identity.proto.rst +++ /dev/null @@ -1,85 +0,0 @@ -.. _api_file_flyteidl/service/identity.proto: - -identity.proto -=============================== - -.. _api_msg_flyteidl.service.UserInfoRequest: - -flyteidl.service.UserInfoRequest --------------------------------- - -`[flyteidl.service.UserInfoRequest proto] `_ - - -.. code-block:: json - - {} - - - - -.. _api_msg_flyteidl.service.UserInfoResponse: - -flyteidl.service.UserInfoResponse ---------------------------------- - -`[flyteidl.service.UserInfoResponse proto] `_ - -See the OpenID Connect spec at https://openid.net/specs/openid-connect-core-1_0.html#UserInfoResponse for more information. - -.. code-block:: json - - { - "subject": "...", - "name": "...", - "preferred_username": "...", - "given_name": "...", - "family_name": "...", - "email": "...", - "picture": "..." - } - -.. _api_field_flyteidl.service.UserInfoResponse.subject: - -subject - (`string `_) Locally unique and never reassigned identifier within the Issuer for the End-User, which is intended to be consumed - by the Client. - - -.. _api_field_flyteidl.service.UserInfoResponse.name: - -name - (`string `_) Full name - - -.. _api_field_flyteidl.service.UserInfoResponse.preferred_username: - -preferred_username - (`string `_) Shorthand name by which the End-User wishes to be referred to - - -.. _api_field_flyteidl.service.UserInfoResponse.given_name: - -given_name - (`string `_) Given name(s) or first name(s) - - -.. _api_field_flyteidl.service.UserInfoResponse.family_name: - -family_name - (`string `_) Surname(s) or last name(s) - - -.. _api_field_flyteidl.service.UserInfoResponse.email: - -email - (`string `_) Preferred e-mail address - - -.. _api_field_flyteidl.service.UserInfoResponse.picture: - -picture - (`string `_) Profile picture URL - - - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/service/index.rst b/flyteidl/gen/pb-protodoc/flyteidl/service/index.rst deleted file mode 100644 index 40c47a7da6..0000000000 --- a/flyteidl/gen/pb-protodoc/flyteidl/service/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -################################################### -REST and gRPC interface for the Flyte Admin Service -################################################### - -This section provides all endpoint defintions that are implemented by the Admin -service. - -.. toctree:: - :maxdepth: 1 - :caption: service - :name: servicetoc - - admin.proto - auth.proto - identity.proto diff --git a/flyteidl/gen/pb-protodoc/google/api/annotations.proto.rst b/flyteidl/gen/pb-protodoc/google/api/annotations.proto.rst deleted file mode 100644 index 0574cad065..0000000000 --- a/flyteidl/gen/pb-protodoc/google/api/annotations.proto.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. _api_file_google/api/annotations.proto: - -annotations.proto -============================ - -Copyright (c) 2015, Google Inc. - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - diff --git a/flyteidl/gen/pb-protodoc/google/api/http.proto.rst b/flyteidl/gen/pb-protodoc/google/api/http.proto.rst deleted file mode 100644 index 226fd3fbfa..0000000000 --- a/flyteidl/gen/pb-protodoc/google/api/http.proto.rst +++ /dev/null @@ -1,496 +0,0 @@ -.. _api_file_google/api/http.proto: - -http.proto -===================== - -Copyright 2019 Google LLC. - -Licensed under the Apache License, Version 2.0 (the "License"); -you may not use this file except in compliance with the License. -You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - - -.. _api_msg_google.api.Http: - -google.api.Http ---------------- - -`[google.api.Http proto] `_ - -Defines the HTTP configuration for an API service. It contains a list of -[HttpRule][google.api.HttpRule], each specifying the mapping of an RPC method -to one or more HTTP REST API methods. - -.. code-block:: json - - { - "rules": [], - "fully_decode_reserved_expansion": "..." - } - -.. _api_field_google.api.Http.rules: - -rules - (:ref:`google.api.HttpRule `) A list of HTTP configuration rules that apply to individual API methods. - - **NOTE:** All service configuration rules follow "last one wins" order. - - -.. _api_field_google.api.Http.fully_decode_reserved_expansion: - -fully_decode_reserved_expansion - (`bool `_) When set to true, URL path parameters will be fully URI-decoded except in - cases of single segment matches in reserved expansion, where "%2F" will be - left encoded. - - The default behavior is to not decode RFC 6570 reserved characters in multi - segment matches. - - - - -.. _api_msg_google.api.HttpRule: - -google.api.HttpRule -------------------- - -`[google.api.HttpRule proto] `_ - -# gRPC Transcoding - -gRPC Transcoding is a feature for mapping between a gRPC method and one or -more HTTP REST endpoints. It allows developers to build a single API service -that supports both gRPC APIs and REST APIs. Many systems, including [Google -APIs](https://github.com/googleapis/googleapis), -[Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC -Gateway](https://github.com/grpc-ecosystem/grpc-gateway), -and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature -and use it for large scale production services. - -`HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies -how different portions of the gRPC request message are mapped to the URL -path, URL query parameters, and HTTP request body. It also controls how the -gRPC response message is mapped to the HTTP response body. `HttpRule` is -typically specified as an `google.api.http` annotation on the gRPC method. - -Each mapping specifies a URL path template and an HTTP method. The path -template may refer to one or more fields in the gRPC request message, as long -as each field is a non-repeated field with a primitive (non-message) type. -The path template controls how fields of the request message are mapped to -the URL path. - -Example: - - service Messaging { - rpc GetMessage(GetMessageRequest) returns (Message) { - option (google.api.http) = { - get: "/v1/{name=messages/*}" - }; - } - } - message GetMessageRequest { - string name = 1; // Mapped to URL path. - } - message Message { - string text = 1; // The resource content. - } - -This enables an HTTP REST to gRPC mapping as below: - -HTTP | gRPC ------|----- -`GET /v1/messages/123456` | `GetMessage(name: "messages/123456")` - -Any fields in the request message which are not bound by the path template -automatically become HTTP query parameters if there is no HTTP request body. -For example: - - service Messaging { - rpc GetMessage(GetMessageRequest) returns (Message) { - option (google.api.http) = { - get:"/v1/messages/{message_id}" - }; - } - } - message GetMessageRequest { - message SubMessage { - string subfield = 1; - } - string message_id = 1; // Mapped to URL path. - int64 revision = 2; // Mapped to URL query parameter `revision`. - SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. - } - -This enables a HTTP JSON to RPC mapping as below: - -HTTP | gRPC ------|----- -`GET /v1/messages/123456?revision=2&sub.subfield=foo` | -`GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: -"foo"))` - -Note that fields which are mapped to URL query parameters must have a -primitive type or a repeated primitive type or a non-repeated message type. -In the case of a repeated type, the parameter can be repeated in the URL -as `...?param=A¶m=B`. In the case of a message type, each field of the -message is mapped to a separate parameter, such as -`...?foo.a=A&foo.b=B&foo.c=C`. - -For HTTP methods that allow a request body, the `body` field -specifies the mapping. Consider a REST update method on the -message resource collection: - - service Messaging { - rpc UpdateMessage(UpdateMessageRequest) returns (Message) { - option (google.api.http) = { - patch: "/v1/messages/{message_id}" - body: "message" - }; - } - } - message UpdateMessageRequest { - string message_id = 1; // mapped to the URL - Message message = 2; // mapped to the body - } - -The following HTTP JSON to RPC mapping is enabled, where the -representation of the JSON in the request body is determined by -protos JSON encoding: - -HTTP | gRPC ------|----- -`PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: -"123456" message { text: "Hi!" })` - -The special name `*` can be used in the body mapping to define that -every field not bound by the path template should be mapped to the -request body. This enables the following alternative definition of -the update method: - - service Messaging { - rpc UpdateMessage(Message) returns (Message) { - option (google.api.http) = { - patch: "/v1/messages/{message_id}" - body: "*" - }; - } - } - message Message { - string message_id = 1; - string text = 2; - } - - -The following HTTP JSON to RPC mapping is enabled: - -HTTP | gRPC ------|----- -`PATCH /v1/messages/123456 { "text": "Hi!" }` | `UpdateMessage(message_id: -"123456" text: "Hi!")` - -Note that when using `*` in the body mapping, it is not possible to -have HTTP parameters, as all fields not bound by the path end in -the body. This makes this option more rarely used in practice when -defining REST APIs. The common usage of `*` is in custom methods -which don't use the URL at all for transferring data. - -It is possible to define multiple HTTP methods for one RPC by using -the `additional_bindings` option. Example: - - service Messaging { - rpc GetMessage(GetMessageRequest) returns (Message) { - option (google.api.http) = { - get: "/v1/messages/{message_id}" - additional_bindings { - get: "/v1/users/{user_id}/messages/{message_id}" - } - }; - } - } - message GetMessageRequest { - string message_id = 1; - string user_id = 2; - } - -This enables the following two alternative HTTP JSON to RPC mappings: - -HTTP | gRPC ------|----- -`GET /v1/messages/123456` | `GetMessage(message_id: "123456")` -`GET /v1/users/me/messages/123456` | `GetMessage(user_id: "me" message_id: -"123456")` - -## Rules for HTTP mapping - -1. Leaf request fields (recursive expansion nested messages in the request - message) are classified into three categories: - - Fields referred by the path template. They are passed via the URL path. - - Fields referred by the [HttpRule.body][google.api.HttpRule.body]. They are passed via the HTTP - request body. - - All other fields are passed via the URL query parameters, and the - parameter name is the field path in the request message. A repeated - field can be represented as multiple query parameters under the same - name. - 2. If [HttpRule.body][google.api.HttpRule.body] is "*", there is no URL query parameter, all fields - are passed via URL path and HTTP request body. - 3. If [HttpRule.body][google.api.HttpRule.body] is omitted, there is no HTTP request body, all - fields are passed via URL path and URL query parameters. - -### Path template syntax - - Template = "/" Segments [ Verb ] ; - Segments = Segment { "/" Segment } ; - Segment = "*" | "**" | LITERAL | Variable ; - Variable = "{" FieldPath [ "=" Segments ] "}" ; - FieldPath = IDENT { "." IDENT } ; - Verb = ":" LITERAL ; - -The syntax `*` matches a single URL path segment. The syntax `**` matches -zero or more URL path segments, which must be the last part of the URL path -except the `Verb`. - -The syntax `Variable` matches part of the URL path as specified by its -template. A variable template must not contain other variables. If a variable -matches a single path segment, its template may be omitted, e.g. `{var}` -is equivalent to `{var=*}`. - -The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` -contains any reserved character, such characters should be percent-encoded -before the matching. - -If a variable contains exactly one path segment, such as `"{var}"` or -`"{var=*}"`, when such a variable is expanded into a URL path on the client -side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The -server side does the reverse decoding. Such variables show up in the -[Discovery -Document](https://developers.google.com/discovery/v1/reference/apis) as -`{var}`. - -If a variable contains multiple path segments, such as `"{var=foo/*}"` -or `"{var=**}"`, when such a variable is expanded into a URL path on the -client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. -The server side does the reverse decoding, except "%2F" and "%2f" are left -unchanged. Such variables show up in the -[Discovery -Document](https://developers.google.com/discovery/v1/reference/apis) as -`{+var}`. - -## Using gRPC API Service Configuration - -gRPC API Service Configuration (service config) is a configuration language -for configuring a gRPC service to become a user-facing product. The -service config is simply the YAML representation of the `google.api.Service` -proto message. - -As an alternative to annotating your proto file, you can configure gRPC -transcoding in your service config YAML files. You do this by specifying a -`HttpRule` that maps the gRPC method to a REST endpoint, achieving the same -effect as the proto annotation. This can be particularly useful if you -have a proto that is reused in multiple services. Note that any transcoding -specified in the service config will override any matching transcoding -configuration in the proto. - -Example: - - http: - rules: - # Selects a gRPC method and applies HttpRule to it. - - selector: example.v1.Messaging.GetMessage - get: /v1/messages/{message_id}/{sub.subfield} - -## Special notes - -When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the -proto to JSON conversion must follow the [proto3 -specification](https://developers.google.com/protocol-buffers/docs/proto3#json). - -While the single segment variable follows the semantics of -[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String -Expansion, the multi segment variable **does not** follow RFC 6570 Section -3.2.3 Reserved Expansion. The reason is that the Reserved Expansion -does not expand special characters like `?` and `#`, which would lead -to invalid URLs. As the result, gRPC Transcoding uses a custom encoding -for multi segment variables. - -The path variables **must not** refer to any repeated or mapped field, -because client libraries are not capable of handling such variable expansion. - -The path variables **must not** capture the leading "/" character. The reason -is that the most common use case "{var}" does not capture the leading "/" -character. For consistency, all path variables must share the same behavior. - -Repeated message fields must not be mapped to URL query parameters, because -no client library can support such complicated mapping. - -If an API needs to use a JSON array for request or response body, it can map -the request or response body to a repeated field. However, some gRPC -Transcoding implementations may not support this feature. - -.. code-block:: json - - { - "selector": "...", - "get": "...", - "put": "...", - "post": "...", - "delete": "...", - "patch": "...", - "custom": "{...}", - "body": "...", - "response_body": "...", - "additional_bindings": [] - } - -.. _api_field_google.api.HttpRule.selector: - -selector - (`string `_) Selects a method to which this rule applies. - - Refer to [selector][google.api.DocumentationRule.selector] for syntax details. - - -.. _api_field_google.api.HttpRule.get: - -get - (`string `_) Maps to HTTP GET. Used for listing and getting information about - resources. - - Determines the URL pattern is matched by this rules. This pattern can be - used with any of the {get|put|post|delete|patch} methods. A custom method - can be defined using the 'custom' field. - - - Only one of :ref:`get `, :ref:`put `, :ref:`post `, :ref:`delete `, :ref:`patch `, :ref:`custom ` may be set. - -.. _api_field_google.api.HttpRule.put: - -put - (`string `_) Maps to HTTP PUT. Used for replacing a resource. - - Determines the URL pattern is matched by this rules. This pattern can be - used with any of the {get|put|post|delete|patch} methods. A custom method - can be defined using the 'custom' field. - - - Only one of :ref:`get `, :ref:`put `, :ref:`post `, :ref:`delete `, :ref:`patch `, :ref:`custom ` may be set. - -.. _api_field_google.api.HttpRule.post: - -post - (`string `_) Maps to HTTP POST. Used for creating a resource or performing an action. - - Determines the URL pattern is matched by this rules. This pattern can be - used with any of the {get|put|post|delete|patch} methods. A custom method - can be defined using the 'custom' field. - - - Only one of :ref:`get `, :ref:`put `, :ref:`post `, :ref:`delete `, :ref:`patch `, :ref:`custom ` may be set. - -.. _api_field_google.api.HttpRule.delete: - -delete - (`string `_) Maps to HTTP DELETE. Used for deleting a resource. - - Determines the URL pattern is matched by this rules. This pattern can be - used with any of the {get|put|post|delete|patch} methods. A custom method - can be defined using the 'custom' field. - - - Only one of :ref:`get `, :ref:`put `, :ref:`post `, :ref:`delete `, :ref:`patch `, :ref:`custom ` may be set. - -.. _api_field_google.api.HttpRule.patch: - -patch - (`string `_) Maps to HTTP PATCH. Used for updating a resource. - - Determines the URL pattern is matched by this rules. This pattern can be - used with any of the {get|put|post|delete|patch} methods. A custom method - can be defined using the 'custom' field. - - - Only one of :ref:`get `, :ref:`put `, :ref:`post `, :ref:`delete `, :ref:`patch `, :ref:`custom ` may be set. - -.. _api_field_google.api.HttpRule.custom: - -custom - (:ref:`google.api.CustomHttpPattern `) The custom pattern is used for specifying an HTTP method that is not - included in the `pattern` field, such as HEAD, or "*" to leave the - HTTP method unspecified for this rule. The wild-card rule is useful - for services that provide content to Web (HTML) clients. - - Determines the URL pattern is matched by this rules. This pattern can be - used with any of the {get|put|post|delete|patch} methods. A custom method - can be defined using the 'custom' field. - - - Only one of :ref:`get `, :ref:`put `, :ref:`post `, :ref:`delete `, :ref:`patch `, :ref:`custom ` may be set. - -.. _api_field_google.api.HttpRule.body: - -body - (`string `_) The name of the request field whose value is mapped to the HTTP request - body, or `*` for mapping all request fields not captured by the path - pattern to the HTTP body, or omitted for not having any HTTP request body. - - NOTE: the referred field must be present at the top-level of the request - message type. - - -.. _api_field_google.api.HttpRule.response_body: - -response_body - (`string `_) Optional. The name of the response field whose value is mapped to the HTTP - response body. When omitted, the entire response message will be used - as the HTTP response body. - - NOTE: The referred field must be present at the top-level of the response - message type. - - -.. _api_field_google.api.HttpRule.additional_bindings: - -additional_bindings - (:ref:`google.api.HttpRule `) Additional HTTP bindings for the selector. Nested bindings must - not contain an `additional_bindings` field themselves (that is, - the nesting may only be one level deep). - - - - -.. _api_msg_google.api.CustomHttpPattern: - -google.api.CustomHttpPattern ----------------------------- - -`[google.api.CustomHttpPattern proto] `_ - -A custom pattern is used for defining custom HTTP verb. - -.. code-block:: json - - { - "kind": "...", - "path": "..." - } - -.. _api_field_google.api.CustomHttpPattern.kind: - -kind - (`string `_) The name of this custom HTTP verb. - - -.. _api_field_google.api.CustomHttpPattern.path: - -path - (`string `_) The path matched by this custom verb. - - - diff --git a/flyteidl/gen/pb-protodoc/google/api/index.rst b/flyteidl/gen/pb-protodoc/google/api/index.rst deleted file mode 100644 index 73c62ee264..0000000000 --- a/flyteidl/gen/pb-protodoc/google/api/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -api -=== - -.. toctree:: - :maxdepth: 1 - :caption: api - :name: apitoc - - annotations.proto - http.proto diff --git a/flyteidl/gen/pb-protodoc/google/index.rst b/flyteidl/gen/pb-protodoc/google/index.rst deleted file mode 100644 index 8c1d1e22b1..0000000000 --- a/flyteidl/gen/pb-protodoc/google/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -google -====== - -.. toctree:: - :maxdepth: 1 - :caption: google - :name: googletoc - - api/index - protobuf/index diff --git a/flyteidl/gen/pb-protodoc/google/protobuf/any.proto.rst b/flyteidl/gen/pb-protodoc/google/protobuf/any.proto.rst deleted file mode 100644 index a91618aa70..0000000000 --- a/flyteidl/gen/pb-protodoc/google/protobuf/any.proto.rst +++ /dev/null @@ -1,170 +0,0 @@ -.. _api_file_google/protobuf/any.proto: - -any.proto -========================= - -Protocol Buffers - Google's data interchange format -Copyright 2008 Google Inc. All rights reserved. -https://developers.google.com/protocol-buffers/ - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are -met: - - * Redistributions of source code must retain the above copyright -notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above -copyright notice, this list of conditions and the following disclaimer -in the documentation and/or other materials provided with the -distribution. - * Neither the name of Google Inc. nor the names of its -contributors may be used to endorse or promote products derived from -this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -.. _api_msg_google.protobuf.Any: - -google.protobuf.Any -------------------- - -`[google.protobuf.Any proto] `_ - -`Any` contains an arbitrary serialized protocol buffer message along with a -URL that describes the type of the serialized message. - -Protobuf library provides support to pack/unpack Any values in the form -of utility functions or additional generated methods of the Any type. - -Example 1: Pack and unpack a message in C++. - - Foo foo = ...; - Any any; - any.PackFrom(foo); - ... - if (any.UnpackTo(&foo)) { - ... - } - -Example 2: Pack and unpack a message in Java. - - Foo foo = ...; - Any any = Any.pack(foo); - ... - if (any.is(Foo.class)) { - foo = any.unpack(Foo.class); - } - - Example 3: Pack and unpack a message in Python. - - foo = Foo(...) - any = Any() - any.Pack(foo) - ... - if any.Is(Foo.DESCRIPTOR): - any.Unpack(foo) - ... - - Example 4: Pack and unpack a message in Go - - foo := &pb.Foo{...} - any, err := ptypes.MarshalAny(foo) - ... - foo := &pb.Foo{} - if err := ptypes.UnmarshalAny(any, foo); err != nil { - ... - } - -The pack methods provided by protobuf library will by default use -'type.googleapis.com/full.type.name' as the type URL and the unpack -methods only use the fully qualified type name after the last '/' -in the type URL, for example "foo.bar.com/x/y.z" will yield type -name "y.z". - - -JSON -==== -The JSON representation of an `Any` value uses the regular -representation of the deserialized, embedded message, with an -additional field `@type` which contains the type URL. Example: - - package google.profile; - message Person { - string first_name = 1; - string last_name = 2; - } - - { - "@type": "type.googleapis.com/google.profile.Person", - "firstName": , - "lastName": - } - -If the embedded message type is well-known and has a custom JSON -representation, that representation will be embedded adding a field -`value` which holds the custom JSON in addition to the `@type` -field. Example (for message [google.protobuf.Duration][]): - - { - "@type": "type.googleapis.com/google.protobuf.Duration", - "value": "1.212s" - } - - -.. code-block:: json - - { - "type_url": "...", - "value": "..." - } - -.. _api_field_google.protobuf.Any.type_url: - -type_url - (`string `_) A URL/resource name that uniquely identifies the type of the serialized - protocol buffer message. This string must contain at least - one "/" character. The last segment of the URL's path must represent - the fully qualified name of the type (as in - `path/google.protobuf.Duration`). The name should be in a canonical form - (e.g., leading "." is not accepted). - - In practice, teams usually precompile into the binary all types that they - expect it to use in the context of Any. However, for URLs which use the - scheme `http`, `https`, or no scheme, one can optionally set up a type - server that maps type URLs to message definitions as follows: - - * If no scheme is provided, `https` is assumed. - * An HTTP GET on the URL must yield a [google.protobuf.Type][] - value in binary format, or produce an error. - * Applications are allowed to cache lookup results based on the - URL, or have them precompiled into a binary to avoid any - lookup. Therefore, binary compatibility needs to be preserved - on changes to types. (Use versioned type names to manage - breaking changes.) - - Note: this functionality is not currently available in the official - protobuf release, and it is not used for type URLs beginning with - type.googleapis.com. - - Schemes other than `http`, `https` (or the empty scheme) might be - used with implementation specific semantics. - - - -.. _api_field_google.protobuf.Any.value: - -value - (`bytes `_) Must be a valid serialized protocol buffer of the above specified type. - - - diff --git a/flyteidl/gen/pb-protodoc/google/protobuf/descriptor.proto.rst b/flyteidl/gen/pb-protodoc/google/protobuf/descriptor.proto.rst deleted file mode 100644 index 5fdc020794..0000000000 --- a/flyteidl/gen/pb-protodoc/google/protobuf/descriptor.proto.rst +++ /dev/null @@ -1,1816 +0,0 @@ -.. _api_file_google/protobuf/descriptor.proto: - -descriptor.proto -================================ - -Protocol Buffers - Google's data interchange format -Copyright 2008 Google Inc. All rights reserved. -https://developers.google.com/protocol-buffers/ - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are -met: - - * Redistributions of source code must retain the above copyright -notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above -copyright notice, this list of conditions and the following disclaimer -in the documentation and/or other materials provided with the -distribution. - * Neither the name of Google Inc. nor the names of its -contributors may be used to endorse or promote products derived from -this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -Author: kenton@google.com (Kenton Varda) - Based on original Protocol Buffers design by - Sanjay Ghemawat, Jeff Dean, and others. - -The messages in this file describe the definitions found in .proto files. -A valid .proto file can be translated directly to a FileDescriptorProto -without any other information (e.g. without reading its imports). - -.. _api_msg_google.protobuf.FileDescriptorSet: - -google.protobuf.FileDescriptorSet ---------------------------------- - -`[google.protobuf.FileDescriptorSet proto] `_ - -The protocol compiler can output a FileDescriptorSet containing the .proto -files it parses. - -.. code-block:: json - - { - "file": [] - } - -.. _api_field_google.protobuf.FileDescriptorSet.file: - -file - (:ref:`google.protobuf.FileDescriptorProto `) - - - -.. _api_msg_google.protobuf.FileDescriptorProto: - -google.protobuf.FileDescriptorProto ------------------------------------ - -`[google.protobuf.FileDescriptorProto proto] `_ - -Describes a complete .proto file. - -.. code-block:: json - - { - "name": "...", - "package": "...", - "dependency": [], - "public_dependency": [], - "weak_dependency": [], - "message_type": [], - "enum_type": [], - "service": [], - "extension": [], - "options": "{...}", - "source_code_info": "{...}", - "syntax": "..." - } - -.. _api_field_google.protobuf.FileDescriptorProto.name: - -name - (`string `_) - -.. _api_field_google.protobuf.FileDescriptorProto.package: - -package - (`string `_) - -.. _api_field_google.protobuf.FileDescriptorProto.dependency: - -dependency - (`string `_) Names of files imported by this file. - - -.. _api_field_google.protobuf.FileDescriptorProto.public_dependency: - -public_dependency - (`int32 `_) Indexes of the public imported files in the dependency list above. - - -.. _api_field_google.protobuf.FileDescriptorProto.weak_dependency: - -weak_dependency - (`int32 `_) Indexes of the weak imported files in the dependency list. - For Google-internal migration only. Do not use. - - -.. _api_field_google.protobuf.FileDescriptorProto.message_type: - -message_type - (:ref:`google.protobuf.DescriptorProto `) All top-level definitions in this file. - - -.. _api_field_google.protobuf.FileDescriptorProto.enum_type: - -enum_type - (:ref:`google.protobuf.EnumDescriptorProto `) - -.. _api_field_google.protobuf.FileDescriptorProto.service: - -service - (:ref:`google.protobuf.ServiceDescriptorProto `) - -.. _api_field_google.protobuf.FileDescriptorProto.extension: - -extension - (:ref:`google.protobuf.FieldDescriptorProto `) - -.. _api_field_google.protobuf.FileDescriptorProto.options: - -options - (:ref:`google.protobuf.FileOptions `) - -.. _api_field_google.protobuf.FileDescriptorProto.source_code_info: - -source_code_info - (:ref:`google.protobuf.SourceCodeInfo `) This field contains optional information about the original source code. - You may safely remove this entire field without harming runtime - functionality of the descriptors -- the information is needed only by - development tools. - - -.. _api_field_google.protobuf.FileDescriptorProto.syntax: - -syntax - (`string `_) The syntax of the proto file. - The supported values are "proto2" and "proto3". - - - - -.. _api_msg_google.protobuf.DescriptorProto: - -google.protobuf.DescriptorProto -------------------------------- - -`[google.protobuf.DescriptorProto proto] `_ - -Describes a message type. - -.. code-block:: json - - { - "name": "...", - "field": [], - "extension": [], - "nested_type": [], - "enum_type": [], - "extension_range": [], - "oneof_decl": [], - "options": "{...}", - "reserved_range": [], - "reserved_name": [] - } - -.. _api_field_google.protobuf.DescriptorProto.name: - -name - (`string `_) - -.. _api_field_google.protobuf.DescriptorProto.field: - -field - (:ref:`google.protobuf.FieldDescriptorProto `) - -.. _api_field_google.protobuf.DescriptorProto.extension: - -extension - (:ref:`google.protobuf.FieldDescriptorProto `) - -.. _api_field_google.protobuf.DescriptorProto.nested_type: - -nested_type - (:ref:`google.protobuf.DescriptorProto `) - -.. _api_field_google.protobuf.DescriptorProto.enum_type: - -enum_type - (:ref:`google.protobuf.EnumDescriptorProto `) - -.. _api_field_google.protobuf.DescriptorProto.extension_range: - -extension_range - (:ref:`google.protobuf.DescriptorProto.ExtensionRange `) - -.. _api_field_google.protobuf.DescriptorProto.oneof_decl: - -oneof_decl - (:ref:`google.protobuf.OneofDescriptorProto `) - -.. _api_field_google.protobuf.DescriptorProto.options: - -options - (:ref:`google.protobuf.MessageOptions `) - -.. _api_field_google.protobuf.DescriptorProto.reserved_range: - -reserved_range - (:ref:`google.protobuf.DescriptorProto.ReservedRange `) - -.. _api_field_google.protobuf.DescriptorProto.reserved_name: - -reserved_name - (`string `_) Reserved field names, which may not be used by fields in the same message. - A given name may only be reserved once. - - -.. _api_msg_google.protobuf.DescriptorProto.ExtensionRange: - -google.protobuf.DescriptorProto.ExtensionRange ----------------------------------------------- - -`[google.protobuf.DescriptorProto.ExtensionRange proto] `_ - - -.. code-block:: json - - { - "start": "...", - "end": "...", - "options": "{...}" - } - -.. _api_field_google.protobuf.DescriptorProto.ExtensionRange.start: - -start - (`int32 `_) - -.. _api_field_google.protobuf.DescriptorProto.ExtensionRange.end: - -end - (`int32 `_) - -.. _api_field_google.protobuf.DescriptorProto.ExtensionRange.options: - -options - (:ref:`google.protobuf.ExtensionRangeOptions `) - - - -.. _api_msg_google.protobuf.DescriptorProto.ReservedRange: - -google.protobuf.DescriptorProto.ReservedRange ---------------------------------------------- - -`[google.protobuf.DescriptorProto.ReservedRange proto] `_ - -Range of reserved tag numbers. Reserved tag numbers may not be used by -fields or extension ranges in the same message. Reserved ranges may -not overlap. - -.. code-block:: json - - { - "start": "...", - "end": "..." - } - -.. _api_field_google.protobuf.DescriptorProto.ReservedRange.start: - -start - (`int32 `_) - -.. _api_field_google.protobuf.DescriptorProto.ReservedRange.end: - -end - (`int32 `_) - - - - -.. _api_msg_google.protobuf.ExtensionRangeOptions: - -google.protobuf.ExtensionRangeOptions -------------------------------------- - -`[google.protobuf.ExtensionRangeOptions proto] `_ - - -.. code-block:: json - - { - "uninterpreted_option": [] - } - -.. _api_field_google.protobuf.ExtensionRangeOptions.uninterpreted_option: - -uninterpreted_option - (:ref:`google.protobuf.UninterpretedOption `) The parser stores options it doesn't recognize here. See above. - - - - -.. _api_msg_google.protobuf.FieldDescriptorProto: - -google.protobuf.FieldDescriptorProto ------------------------------------- - -`[google.protobuf.FieldDescriptorProto proto] `_ - -Describes a field within a message. - -.. code-block:: json - - { - "name": "...", - "number": "...", - "label": "...", - "type": "...", - "type_name": "...", - "extendee": "...", - "default_value": "...", - "oneof_index": "...", - "json_name": "...", - "options": "{...}" - } - -.. _api_field_google.protobuf.FieldDescriptorProto.name: - -name - (`string `_) - -.. _api_field_google.protobuf.FieldDescriptorProto.number: - -number - (`int32 `_) - -.. _api_field_google.protobuf.FieldDescriptorProto.label: - -label - (:ref:`google.protobuf.FieldDescriptorProto.Label `) - -.. _api_field_google.protobuf.FieldDescriptorProto.type: - -type - (:ref:`google.protobuf.FieldDescriptorProto.Type `) If type_name is set, this need not be set. If both this and type_name - are set, this must be one of TYPE_ENUM, TYPE_MESSAGE or TYPE_GROUP. - - -.. _api_field_google.protobuf.FieldDescriptorProto.type_name: - -type_name - (`string `_) For message and enum types, this is the name of the type. If the name - starts with a '.', it is fully-qualified. Otherwise, C++-like scoping - rules are used to find the type (i.e. first the nested types within this - message are searched, then within the parent, on up to the root - namespace). - - -.. _api_field_google.protobuf.FieldDescriptorProto.extendee: - -extendee - (`string `_) For extensions, this is the name of the type being extended. It is - resolved in the same manner as type_name. - - -.. _api_field_google.protobuf.FieldDescriptorProto.default_value: - -default_value - (`string `_) For numeric types, contains the original text representation of the value. - For booleans, "true" or "false". - For strings, contains the default text contents (not escaped in any way). - For bytes, contains the C escaped value. All bytes >= 128 are escaped. - TODO(kenton): Base-64 encode? - - -.. _api_field_google.protobuf.FieldDescriptorProto.oneof_index: - -oneof_index - (`int32 `_) If set, gives the index of a oneof in the containing type's oneof_decl - list. This field is a member of that oneof. - - -.. _api_field_google.protobuf.FieldDescriptorProto.json_name: - -json_name - (`string `_) JSON name of this field. The value is set by protocol compiler. If the - user has set a "json_name" option on this field, that option's value - will be used. Otherwise, it's deduced from the field's name by converting - it to camelCase. - - -.. _api_field_google.protobuf.FieldDescriptorProto.options: - -options - (:ref:`google.protobuf.FieldOptions `) - - -.. _api_enum_google.protobuf.FieldDescriptorProto.Type: - -Enum google.protobuf.FieldDescriptorProto.Type ----------------------------------------------- - -`[google.protobuf.FieldDescriptorProto.Type proto] `_ - - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_DOUBLE: - -TYPE_DOUBLE - ⁣0 is reserved for errors. - Order is weird for historical reasons. - - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_FLOAT: - -TYPE_FLOAT - ⁣ - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_INT64: - -TYPE_INT64 - ⁣Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT64 if - negative values are likely. - - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_UINT64: - -TYPE_UINT64 - ⁣ - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_INT32: - -TYPE_INT32 - ⁣Not ZigZag encoded. Negative numbers take 10 bytes. Use TYPE_SINT32 if - negative values are likely. - - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_FIXED64: - -TYPE_FIXED64 - ⁣ - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_FIXED32: - -TYPE_FIXED32 - ⁣ - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_BOOL: - -TYPE_BOOL - ⁣ - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_STRING: - -TYPE_STRING - ⁣ - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_GROUP: - -TYPE_GROUP - ⁣Tag-delimited aggregate. - Group type is deprecated and not supported in proto3. However, Proto3 - implementations should still be able to parse the group wire format and - treat group fields as unknown fields. - - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_MESSAGE: - -TYPE_MESSAGE - ⁣ - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_BYTES: - -TYPE_BYTES - ⁣New in version 2. - - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_UINT32: - -TYPE_UINT32 - ⁣ - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_ENUM: - -TYPE_ENUM - ⁣ - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_SFIXED32: - -TYPE_SFIXED32 - ⁣ - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_SFIXED64: - -TYPE_SFIXED64 - ⁣ - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_SINT32: - -TYPE_SINT32 - ⁣ - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Type.TYPE_SINT64: - -TYPE_SINT64 - ⁣ - - -.. _api_enum_google.protobuf.FieldDescriptorProto.Label: - -Enum google.protobuf.FieldDescriptorProto.Label ------------------------------------------------ - -`[google.protobuf.FieldDescriptorProto.Label proto] `_ - - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Label.LABEL_OPTIONAL: - -LABEL_OPTIONAL - ⁣0 is reserved for errors - - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Label.LABEL_REQUIRED: - -LABEL_REQUIRED - ⁣ - -.. _api_enum_value_google.protobuf.FieldDescriptorProto.Label.LABEL_REPEATED: - -LABEL_REPEATED - ⁣ - - -.. _api_msg_google.protobuf.OneofDescriptorProto: - -google.protobuf.OneofDescriptorProto ------------------------------------- - -`[google.protobuf.OneofDescriptorProto proto] `_ - -Describes a oneof. - -.. code-block:: json - - { - "name": "...", - "options": "{...}" - } - -.. _api_field_google.protobuf.OneofDescriptorProto.name: - -name - (`string `_) - -.. _api_field_google.protobuf.OneofDescriptorProto.options: - -options - (:ref:`google.protobuf.OneofOptions `) - - - -.. _api_msg_google.protobuf.EnumDescriptorProto: - -google.protobuf.EnumDescriptorProto ------------------------------------ - -`[google.protobuf.EnumDescriptorProto proto] `_ - -Describes an enum type. - -.. code-block:: json - - { - "name": "...", - "value": [], - "options": "{...}", - "reserved_range": [], - "reserved_name": [] - } - -.. _api_field_google.protobuf.EnumDescriptorProto.name: - -name - (`string `_) - -.. _api_field_google.protobuf.EnumDescriptorProto.value: - -value - (:ref:`google.protobuf.EnumValueDescriptorProto `) - -.. _api_field_google.protobuf.EnumDescriptorProto.options: - -options - (:ref:`google.protobuf.EnumOptions `) - -.. _api_field_google.protobuf.EnumDescriptorProto.reserved_range: - -reserved_range - (:ref:`google.protobuf.EnumDescriptorProto.EnumReservedRange `) Range of reserved numeric values. Reserved numeric values may not be used - by enum values in the same enum declaration. Reserved ranges may not - overlap. - - -.. _api_field_google.protobuf.EnumDescriptorProto.reserved_name: - -reserved_name - (`string `_) Reserved enum value names, which may not be reused. A given name may only - be reserved once. - - -.. _api_msg_google.protobuf.EnumDescriptorProto.EnumReservedRange: - -google.protobuf.EnumDescriptorProto.EnumReservedRange ------------------------------------------------------ - -`[google.protobuf.EnumDescriptorProto.EnumReservedRange proto] `_ - -Range of reserved numeric values. Reserved values may not be used by -entries in the same enum. Reserved ranges may not overlap. - -Note that this is distinct from DescriptorProto.ReservedRange in that it -is inclusive such that it can appropriately represent the entire int32 -domain. - -.. code-block:: json - - { - "start": "...", - "end": "..." - } - -.. _api_field_google.protobuf.EnumDescriptorProto.EnumReservedRange.start: - -start - (`int32 `_) - -.. _api_field_google.protobuf.EnumDescriptorProto.EnumReservedRange.end: - -end - (`int32 `_) - - - - -.. _api_msg_google.protobuf.EnumValueDescriptorProto: - -google.protobuf.EnumValueDescriptorProto ----------------------------------------- - -`[google.protobuf.EnumValueDescriptorProto proto] `_ - -Describes a value within an enum. - -.. code-block:: json - - { - "name": "...", - "number": "...", - "options": "{...}" - } - -.. _api_field_google.protobuf.EnumValueDescriptorProto.name: - -name - (`string `_) - -.. _api_field_google.protobuf.EnumValueDescriptorProto.number: - -number - (`int32 `_) - -.. _api_field_google.protobuf.EnumValueDescriptorProto.options: - -options - (:ref:`google.protobuf.EnumValueOptions `) - - - -.. _api_msg_google.protobuf.ServiceDescriptorProto: - -google.protobuf.ServiceDescriptorProto --------------------------------------- - -`[google.protobuf.ServiceDescriptorProto proto] `_ - -Describes a service. - -.. code-block:: json - - { - "name": "...", - "method": [], - "options": "{...}" - } - -.. _api_field_google.protobuf.ServiceDescriptorProto.name: - -name - (`string `_) - -.. _api_field_google.protobuf.ServiceDescriptorProto.method: - -method - (:ref:`google.protobuf.MethodDescriptorProto `) - -.. _api_field_google.protobuf.ServiceDescriptorProto.options: - -options - (:ref:`google.protobuf.ServiceOptions `) - - - -.. _api_msg_google.protobuf.MethodDescriptorProto: - -google.protobuf.MethodDescriptorProto -------------------------------------- - -`[google.protobuf.MethodDescriptorProto proto] `_ - -Describes a method of a service. - -.. code-block:: json - - { - "name": "...", - "input_type": "...", - "output_type": "...", - "options": "{...}", - "client_streaming": "...", - "server_streaming": "..." - } - -.. _api_field_google.protobuf.MethodDescriptorProto.name: - -name - (`string `_) - -.. _api_field_google.protobuf.MethodDescriptorProto.input_type: - -input_type - (`string `_) Input and output type names. These are resolved in the same way as - FieldDescriptorProto.type_name, but must refer to a message type. - - -.. _api_field_google.protobuf.MethodDescriptorProto.output_type: - -output_type - (`string `_) - -.. _api_field_google.protobuf.MethodDescriptorProto.options: - -options - (:ref:`google.protobuf.MethodOptions `) - -.. _api_field_google.protobuf.MethodDescriptorProto.client_streaming: - -client_streaming - (`bool `_) Identifies if client streams multiple client messages - - -.. _api_field_google.protobuf.MethodDescriptorProto.server_streaming: - -server_streaming - (`bool `_) Identifies if server streams multiple server messages - - - - -.. _api_msg_google.protobuf.FileOptions: - -google.protobuf.FileOptions ---------------------------- - -`[google.protobuf.FileOptions proto] `_ - - -.. code-block:: json - - { - "java_package": "...", - "java_outer_classname": "...", - "java_multiple_files": "...", - "java_generate_equals_and_hash": "...", - "java_string_check_utf8": "...", - "optimize_for": "...", - "go_package": "...", - "cc_generic_services": "...", - "java_generic_services": "...", - "py_generic_services": "...", - "php_generic_services": "...", - "deprecated": "...", - "cc_enable_arenas": "...", - "objc_class_prefix": "...", - "csharp_namespace": "...", - "swift_prefix": "...", - "php_class_prefix": "...", - "php_namespace": "...", - "php_metadata_namespace": "...", - "ruby_package": "...", - "uninterpreted_option": [] - } - -.. _api_field_google.protobuf.FileOptions.java_package: - -java_package - (`string `_) Sets the Java package where classes generated from this .proto will be - placed. By default, the proto package is used, but this is often - inappropriate because proto packages do not normally start with backwards - domain names. - - -.. _api_field_google.protobuf.FileOptions.java_outer_classname: - -java_outer_classname - (`string `_) If set, all the classes from the .proto file are wrapped in a single - outer class with the given name. This applies to both Proto1 - (equivalent to the old "--one_java_file" option) and Proto2 (where - a .proto always translates to a single class, but you may want to - explicitly choose the class name). - - -.. _api_field_google.protobuf.FileOptions.java_multiple_files: - -java_multiple_files - (`bool `_) If set true, then the Java code generator will generate a separate .java - file for each top-level message, enum, and service defined in the .proto - file. Thus, these types will *not* be nested inside the outer class - named by java_outer_classname. However, the outer class will still be - generated to contain the file's getDescriptor() method as well as any - top-level extensions defined in the file. - - -.. _api_field_google.protobuf.FileOptions.java_generate_equals_and_hash: - -java_generate_equals_and_hash - (`bool `_) This option does nothing. - - -.. _api_field_google.protobuf.FileOptions.java_string_check_utf8: - -java_string_check_utf8 - (`bool `_) If set true, then the Java2 code generator will generate code that - throws an exception whenever an attempt is made to assign a non-UTF-8 - byte sequence to a string field. - Message reflection will do the same. - However, an extension field still accepts non-UTF-8 byte sequences. - This option has no effect on when used with the lite runtime. - - -.. _api_field_google.protobuf.FileOptions.optimize_for: - -optimize_for - (:ref:`google.protobuf.FileOptions.OptimizeMode `) - -.. _api_field_google.protobuf.FileOptions.go_package: - -go_package - (`string `_) Sets the Go package where structs generated from this .proto will be - placed. If omitted, the Go package will be derived from the following: - - The basename of the package import path, if provided. - - Otherwise, the package statement in the .proto file, if present. - - Otherwise, the basename of the .proto file, without extension. - - -.. _api_field_google.protobuf.FileOptions.cc_generic_services: - -cc_generic_services - (`bool `_) Should generic services be generated in each language? "Generic" services - are not specific to any particular RPC system. They are generated by the - main code generators in each language (without additional plugins). - Generic services were the only kind of service generation supported by - early versions of google.protobuf. - - Generic services are now considered deprecated in favor of using plugins - that generate code specific to your particular RPC system. Therefore, - these default to false. Old code which depends on generic services should - explicitly set them to true. - - -.. _api_field_google.protobuf.FileOptions.java_generic_services: - -java_generic_services - (`bool `_) - -.. _api_field_google.protobuf.FileOptions.py_generic_services: - -py_generic_services - (`bool `_) - -.. _api_field_google.protobuf.FileOptions.php_generic_services: - -php_generic_services - (`bool `_) - -.. _api_field_google.protobuf.FileOptions.deprecated: - -deprecated - (`bool `_) Is this file deprecated? - Depending on the target platform, this can emit Deprecated annotations - for everything in the file, or it will be completely ignored; in the very - least, this is a formalization for deprecating files. - - -.. _api_field_google.protobuf.FileOptions.cc_enable_arenas: - -cc_enable_arenas - (`bool `_) Enables the use of arenas for the proto messages in this file. This applies - only to generated classes for C++. - - -.. _api_field_google.protobuf.FileOptions.objc_class_prefix: - -objc_class_prefix - (`string `_) Sets the objective c class prefix which is prepended to all objective c - generated classes from this .proto. There is no default. - - -.. _api_field_google.protobuf.FileOptions.csharp_namespace: - -csharp_namespace - (`string `_) Namespace for generated classes; defaults to the package. - - -.. _api_field_google.protobuf.FileOptions.swift_prefix: - -swift_prefix - (`string `_) By default Swift generators will take the proto package and CamelCase it - replacing '.' with underscore and use that to prefix the types/symbols - defined. When this options is provided, they will use this value instead - to prefix the types/symbols defined. - - -.. _api_field_google.protobuf.FileOptions.php_class_prefix: - -php_class_prefix - (`string `_) Sets the php class prefix which is prepended to all php generated classes - from this .proto. Default is empty. - - -.. _api_field_google.protobuf.FileOptions.php_namespace: - -php_namespace - (`string `_) Use this option to change the namespace of php generated classes. Default - is empty. When this option is empty, the package name will be used for - determining the namespace. - - -.. _api_field_google.protobuf.FileOptions.php_metadata_namespace: - -php_metadata_namespace - (`string `_) Use this option to change the namespace of php generated metadata classes. - Default is empty. When this option is empty, the proto file name will be used - for determining the namespace. - - -.. _api_field_google.protobuf.FileOptions.ruby_package: - -ruby_package - (`string `_) Use this option to change the package of ruby generated classes. Default - is empty. When this option is not set, the package name will be used for - determining the ruby package. - - -.. _api_field_google.protobuf.FileOptions.uninterpreted_option: - -uninterpreted_option - (:ref:`google.protobuf.UninterpretedOption `) The parser stores options it doesn't recognize here. - See the documentation for the "Options" section above. - - - -.. _api_enum_google.protobuf.FileOptions.OptimizeMode: - -Enum google.protobuf.FileOptions.OptimizeMode ---------------------------------------------- - -`[google.protobuf.FileOptions.OptimizeMode proto] `_ - -Generated classes can be optimized for speed or code size. - -.. _api_enum_value_google.protobuf.FileOptions.OptimizeMode.SPEED: - -SPEED - ⁣ - -.. _api_enum_value_google.protobuf.FileOptions.OptimizeMode.CODE_SIZE: - -CODE_SIZE - ⁣etc. - - -.. _api_enum_value_google.protobuf.FileOptions.OptimizeMode.LITE_RUNTIME: - -LITE_RUNTIME - ⁣ - - -.. _api_msg_google.protobuf.MessageOptions: - -google.protobuf.MessageOptions ------------------------------- - -`[google.protobuf.MessageOptions proto] `_ - - -.. code-block:: json - - { - "message_set_wire_format": "...", - "no_standard_descriptor_accessor": "...", - "deprecated": "...", - "map_entry": "...", - "uninterpreted_option": [] - } - -.. _api_field_google.protobuf.MessageOptions.message_set_wire_format: - -message_set_wire_format - (`bool `_) Set true to use the old proto1 MessageSet wire format for extensions. - This is provided for backwards-compatibility with the MessageSet wire - format. You should not use this for any other reason: It's less - efficient, has fewer features, and is more complicated. - - The message must be defined exactly as follows: - message Foo { - option message_set_wire_format = true; - extensions 4 to max; - } - Note that the message cannot have any defined fields; MessageSets only - have extensions. - - All extensions of your type must be singular messages; e.g. they cannot - be int32s, enums, or repeated messages. - - Because this is an option, the above two restrictions are not enforced by - the protocol compiler. - - -.. _api_field_google.protobuf.MessageOptions.no_standard_descriptor_accessor: - -no_standard_descriptor_accessor - (`bool `_) Disables the generation of the standard "descriptor()" accessor, which can - conflict with a field of the same name. This is meant to make migration - from proto1 easier; new code should avoid fields named "descriptor". - - -.. _api_field_google.protobuf.MessageOptions.deprecated: - -deprecated - (`bool `_) Is this message deprecated? - Depending on the target platform, this can emit Deprecated annotations - for the message, or it will be completely ignored; in the very least, - this is a formalization for deprecating messages. - - -.. _api_field_google.protobuf.MessageOptions.map_entry: - -map_entry - (`bool `_) Whether the message is an automatically generated map entry type for the - maps field. - - For maps fields: - map map_field = 1; - The parsed descriptor looks like: - message MapFieldEntry { - option map_entry = true; - optional KeyType key = 1; - optional ValueType value = 2; - } - repeated MapFieldEntry map_field = 1; - - Implementations may choose not to generate the map_entry=true message, but - use a native map in the target language to hold the keys and values. - The reflection APIs in such implementions still need to work as - if the field is a repeated message field. - - NOTE: Do not set the option in .proto files. Always use the maps syntax - instead. The option should only be implicitly set by the proto compiler - parser. - - -.. _api_field_google.protobuf.MessageOptions.uninterpreted_option: - -uninterpreted_option - (:ref:`google.protobuf.UninterpretedOption `) The parser stores options it doesn't recognize here. See above. - - - - -.. _api_msg_google.protobuf.FieldOptions: - -google.protobuf.FieldOptions ----------------------------- - -`[google.protobuf.FieldOptions proto] `_ - - -.. code-block:: json - - { - "ctype": "...", - "packed": "...", - "jstype": "...", - "lazy": "...", - "deprecated": "...", - "weak": "...", - "uninterpreted_option": [] - } - -.. _api_field_google.protobuf.FieldOptions.ctype: - -ctype - (:ref:`google.protobuf.FieldOptions.CType `) The ctype option instructs the C++ code generator to use a different - representation of the field than it normally would. See the specific - options below. This option is not yet implemented in the open source - release -- sorry, we'll try to include it in a future version! - - -.. _api_field_google.protobuf.FieldOptions.packed: - -packed - (`bool `_) The packed option can be enabled for repeated primitive fields to enable - a more efficient representation on the wire. Rather than repeatedly - writing the tag and type for each element, the entire array is encoded as - a single length-delimited blob. In proto3, only explicit setting it to - false will avoid using packed encoding. - - -.. _api_field_google.protobuf.FieldOptions.jstype: - -jstype - (:ref:`google.protobuf.FieldOptions.JSType `) The jstype option determines the JavaScript type used for values of the - field. The option is permitted only for 64 bit integral and fixed types - (int64, uint64, sint64, fixed64, sfixed64). A field with jstype JS_STRING - is represented as JavaScript string, which avoids loss of precision that - can happen when a large value is converted to a floating point JavaScript. - Specifying JS_NUMBER for the jstype causes the generated JavaScript code to - use the JavaScript "number" type. The behavior of the default option - JS_NORMAL is implementation dependent. - - This option is an enum to permit additional types to be added, e.g. - goog.math.Integer. - - -.. _api_field_google.protobuf.FieldOptions.lazy: - -lazy - (`bool `_) Should this field be parsed lazily? Lazy applies only to message-type - fields. It means that when the outer message is initially parsed, the - inner message's contents will not be parsed but instead stored in encoded - form. The inner message will actually be parsed when it is first accessed. - - This is only a hint. Implementations are free to choose whether to use - eager or lazy parsing regardless of the value of this option. However, - setting this option true suggests that the protocol author believes that - using lazy parsing on this field is worth the additional bookkeeping - overhead typically needed to implement it. - - This option does not affect the public interface of any generated code; - all method signatures remain the same. Furthermore, thread-safety of the - interface is not affected by this option; const methods remain safe to - call from multiple threads concurrently, while non-const methods continue - to require exclusive access. - - - Note that implementations may choose not to check required fields within - a lazy sub-message. That is, calling IsInitialized() on the outer message - may return true even if the inner message has missing required fields. - This is necessary because otherwise the inner message would have to be - parsed in order to perform the check, defeating the purpose of lazy - parsing. An implementation which chooses not to check required fields - must be consistent about it. That is, for any particular sub-message, the - implementation must either *always* check its required fields, or *never* - check its required fields, regardless of whether or not the message has - been parsed. - - -.. _api_field_google.protobuf.FieldOptions.deprecated: - -deprecated - (`bool `_) Is this field deprecated? - Depending on the target platform, this can emit Deprecated annotations - for accessors, or it will be completely ignored; in the very least, this - is a formalization for deprecating fields. - - -.. _api_field_google.protobuf.FieldOptions.weak: - -weak - (`bool `_) For Google-internal migration only. Do not use. - - -.. _api_field_google.protobuf.FieldOptions.uninterpreted_option: - -uninterpreted_option - (:ref:`google.protobuf.UninterpretedOption `) The parser stores options it doesn't recognize here. See above. - - - -.. _api_enum_google.protobuf.FieldOptions.CType: - -Enum google.protobuf.FieldOptions.CType ---------------------------------------- - -`[google.protobuf.FieldOptions.CType proto] `_ - - -.. _api_enum_value_google.protobuf.FieldOptions.CType.STRING: - -STRING - *(DEFAULT)* ⁣Default mode. - - -.. _api_enum_value_google.protobuf.FieldOptions.CType.CORD: - -CORD - ⁣ - -.. _api_enum_value_google.protobuf.FieldOptions.CType.STRING_PIECE: - -STRING_PIECE - ⁣ - - -.. _api_enum_google.protobuf.FieldOptions.JSType: - -Enum google.protobuf.FieldOptions.JSType ----------------------------------------- - -`[google.protobuf.FieldOptions.JSType proto] `_ - - -.. _api_enum_value_google.protobuf.FieldOptions.JSType.JS_NORMAL: - -JS_NORMAL - *(DEFAULT)* ⁣Use the default type. - - -.. _api_enum_value_google.protobuf.FieldOptions.JSType.JS_STRING: - -JS_STRING - ⁣Use JavaScript strings. - - -.. _api_enum_value_google.protobuf.FieldOptions.JSType.JS_NUMBER: - -JS_NUMBER - ⁣Use JavaScript numbers. - - - -.. _api_msg_google.protobuf.OneofOptions: - -google.protobuf.OneofOptions ----------------------------- - -`[google.protobuf.OneofOptions proto] `_ - - -.. code-block:: json - - { - "uninterpreted_option": [] - } - -.. _api_field_google.protobuf.OneofOptions.uninterpreted_option: - -uninterpreted_option - (:ref:`google.protobuf.UninterpretedOption `) The parser stores options it doesn't recognize here. See above. - - - - -.. _api_msg_google.protobuf.EnumOptions: - -google.protobuf.EnumOptions ---------------------------- - -`[google.protobuf.EnumOptions proto] `_ - - -.. code-block:: json - - { - "allow_alias": "...", - "deprecated": "...", - "uninterpreted_option": [] - } - -.. _api_field_google.protobuf.EnumOptions.allow_alias: - -allow_alias - (`bool `_) Set this option to true to allow mapping different tag names to the same - value. - - -.. _api_field_google.protobuf.EnumOptions.deprecated: - -deprecated - (`bool `_) Is this enum deprecated? - Depending on the target platform, this can emit Deprecated annotations - for the enum, or it will be completely ignored; in the very least, this - is a formalization for deprecating enums. - - -.. _api_field_google.protobuf.EnumOptions.uninterpreted_option: - -uninterpreted_option - (:ref:`google.protobuf.UninterpretedOption `) The parser stores options it doesn't recognize here. See above. - - - - -.. _api_msg_google.protobuf.EnumValueOptions: - -google.protobuf.EnumValueOptions --------------------------------- - -`[google.protobuf.EnumValueOptions proto] `_ - - -.. code-block:: json - - { - "deprecated": "...", - "uninterpreted_option": [] - } - -.. _api_field_google.protobuf.EnumValueOptions.deprecated: - -deprecated - (`bool `_) Is this enum value deprecated? - Depending on the target platform, this can emit Deprecated annotations - for the enum value, or it will be completely ignored; in the very least, - this is a formalization for deprecating enum values. - - -.. _api_field_google.protobuf.EnumValueOptions.uninterpreted_option: - -uninterpreted_option - (:ref:`google.protobuf.UninterpretedOption `) The parser stores options it doesn't recognize here. See above. - - - - -.. _api_msg_google.protobuf.ServiceOptions: - -google.protobuf.ServiceOptions ------------------------------- - -`[google.protobuf.ServiceOptions proto] `_ - - -.. code-block:: json - - { - "deprecated": "...", - "uninterpreted_option": [] - } - -.. _api_field_google.protobuf.ServiceOptions.deprecated: - -deprecated - (`bool `_) Is this service deprecated? - Depending on the target platform, this can emit Deprecated annotations - for the service, or it will be completely ignored; in the very least, - this is a formalization for deprecating services. - - -.. _api_field_google.protobuf.ServiceOptions.uninterpreted_option: - -uninterpreted_option - (:ref:`google.protobuf.UninterpretedOption `) The parser stores options it doesn't recognize here. See above. - - - - -.. _api_msg_google.protobuf.MethodOptions: - -google.protobuf.MethodOptions ------------------------------ - -`[google.protobuf.MethodOptions proto] `_ - - -.. code-block:: json - - { - "deprecated": "...", - "idempotency_level": "...", - "uninterpreted_option": [] - } - -.. _api_field_google.protobuf.MethodOptions.deprecated: - -deprecated - (`bool `_) Is this method deprecated? - Depending on the target platform, this can emit Deprecated annotations - for the method, or it will be completely ignored; in the very least, - this is a formalization for deprecating methods. - - -.. _api_field_google.protobuf.MethodOptions.idempotency_level: - -idempotency_level - (:ref:`google.protobuf.MethodOptions.IdempotencyLevel `) - -.. _api_field_google.protobuf.MethodOptions.uninterpreted_option: - -uninterpreted_option - (:ref:`google.protobuf.UninterpretedOption `) The parser stores options it doesn't recognize here. See above. - - - -.. _api_enum_google.protobuf.MethodOptions.IdempotencyLevel: - -Enum google.protobuf.MethodOptions.IdempotencyLevel ---------------------------------------------------- - -`[google.protobuf.MethodOptions.IdempotencyLevel proto] `_ - -Is this method side-effect-free (or safe in HTTP parlance), or idempotent, -or neither? HTTP based RPC implementation may choose GET verb for safe -methods, and PUT verb for idempotent methods instead of the default POST. - -.. _api_enum_value_google.protobuf.MethodOptions.IdempotencyLevel.IDEMPOTENCY_UNKNOWN: - -IDEMPOTENCY_UNKNOWN - *(DEFAULT)* ⁣ - -.. _api_enum_value_google.protobuf.MethodOptions.IdempotencyLevel.NO_SIDE_EFFECTS: - -NO_SIDE_EFFECTS - ⁣ - -.. _api_enum_value_google.protobuf.MethodOptions.IdempotencyLevel.IDEMPOTENT: - -IDEMPOTENT - ⁣ - - -.. _api_msg_google.protobuf.UninterpretedOption: - -google.protobuf.UninterpretedOption ------------------------------------ - -`[google.protobuf.UninterpretedOption proto] `_ - -A message representing a option the parser does not recognize. This only -appears in options protos created by the compiler::Parser class. -DescriptorPool resolves these when building Descriptor objects. Therefore, -options protos in descriptor objects (e.g. returned by Descriptor::options(), -or produced by Descriptor::CopyTo()) will never have UninterpretedOptions -in them. - -.. code-block:: json - - { - "name": [], - "identifier_value": "...", - "positive_int_value": "...", - "negative_int_value": "...", - "double_value": "...", - "string_value": "...", - "aggregate_value": "..." - } - -.. _api_field_google.protobuf.UninterpretedOption.name: - -name - (:ref:`google.protobuf.UninterpretedOption.NamePart `) - -.. _api_field_google.protobuf.UninterpretedOption.identifier_value: - -identifier_value - (`string `_) The value of the uninterpreted option, in whatever type the tokenizer - identified it as during parsing. Exactly one of these should be set. - - -.. _api_field_google.protobuf.UninterpretedOption.positive_int_value: - -positive_int_value - (`uint64 `_) - -.. _api_field_google.protobuf.UninterpretedOption.negative_int_value: - -negative_int_value - (`int64 `_) - -.. _api_field_google.protobuf.UninterpretedOption.double_value: - -double_value - (`double `_) - -.. _api_field_google.protobuf.UninterpretedOption.string_value: - -string_value - (`bytes `_) - -.. _api_field_google.protobuf.UninterpretedOption.aggregate_value: - -aggregate_value - (`string `_) - -.. _api_msg_google.protobuf.UninterpretedOption.NamePart: - -google.protobuf.UninterpretedOption.NamePart --------------------------------------------- - -`[google.protobuf.UninterpretedOption.NamePart proto] `_ - -The name of the uninterpreted option. Each string represents a segment in -a dot-separated name. is_extension is true iff a segment represents an -extension (denoted with parentheses in options specs in .proto files). -E.g.,{ ["foo", false], ["bar.baz", true], ["qux", false] } represents -"foo.(bar.baz).qux". - -.. code-block:: json - - { - "name_part": "...", - "is_extension": "..." - } - -.. _api_field_google.protobuf.UninterpretedOption.NamePart.name_part: - -name_part - (`string `_) - -.. _api_field_google.protobuf.UninterpretedOption.NamePart.is_extension: - -is_extension - (`bool `_) - - - - -.. _api_msg_google.protobuf.SourceCodeInfo: - -google.protobuf.SourceCodeInfo ------------------------------- - -`[google.protobuf.SourceCodeInfo proto] `_ - -Encapsulates information about the original source file from which a -FileDescriptorProto was generated. - -.. code-block:: json - - { - "location": [] - } - -.. _api_field_google.protobuf.SourceCodeInfo.location: - -location - (:ref:`google.protobuf.SourceCodeInfo.Location `) A Location identifies a piece of source code in a .proto file which - corresponds to a particular definition. This information is intended - to be useful to IDEs, code indexers, documentation generators, and similar - tools. - - For example, say we have a file like: - message Foo { - optional string foo = 1; - } - Let's look at just the field definition: - optional string foo = 1; - ^ ^^ ^^ ^ ^^^ - a bc de f ghi - We have the following locations: - span path represents - [a,i) [ 4, 0, 2, 0 ] The whole field definition. - [a,b) [ 4, 0, 2, 0, 4 ] The label (optional). - [c,d) [ 4, 0, 2, 0, 5 ] The type (string). - [e,f) [ 4, 0, 2, 0, 1 ] The name (foo). - [g,h) [ 4, 0, 2, 0, 3 ] The number (1). - - Notes: - - A location may refer to a repeated field itself (i.e. not to any - particular index within it). This is used whenever a set of elements are - logically enclosed in a single code segment. For example, an entire - extend block (possibly containing multiple extension definitions) will - have an outer location whose path refers to the "extensions" repeated - field without an index. - - Multiple locations may have the same path. This happens when a single - logical declaration is spread out across multiple places. The most - obvious example is the "extend" block again -- there may be multiple - extend blocks in the same scope, each of which will have the same path. - - A location's span is not always a subset of its parent's span. For - example, the "extendee" of an extension declaration appears at the - beginning of the "extend" block and is shared by all extensions within - the block. - - Just because a location's span is a subset of some other location's span - does not mean that it is a descendent. For example, a "group" defines - both a type and a field in a single declaration. Thus, the locations - corresponding to the type and field and their components will overlap. - - Code which tries to interpret locations should probably be designed to - ignore those that it doesn't understand, as more types of locations could - be recorded in the future. - - -.. _api_msg_google.protobuf.SourceCodeInfo.Location: - -google.protobuf.SourceCodeInfo.Location ---------------------------------------- - -`[google.protobuf.SourceCodeInfo.Location proto] `_ - - -.. code-block:: json - - { - "path": [], - "span": [], - "leading_comments": "...", - "trailing_comments": "...", - "leading_detached_comments": [] - } - -.. _api_field_google.protobuf.SourceCodeInfo.Location.path: - -path - (`int32 `_) Identifies which part of the FileDescriptorProto was defined at this - location. - - Each element is a field number or an index. They form a path from - the root FileDescriptorProto to the place where the definition. For - example, this path: - [ 4, 3, 2, 7, 1 ] - refers to: - file.message_type(3) // 4, 3 - .field(7) // 2, 7 - .name() // 1 - This is because FileDescriptorProto.message_type has field number 4: - repeated DescriptorProto message_type = 4; - and DescriptorProto.field has field number 2: - repeated FieldDescriptorProto field = 2; - and FieldDescriptorProto.name has field number 1: - optional string name = 1; - - Thus, the above path gives the location of a field name. If we removed - the last element: - [ 4, 3, 2, 7 ] - this path refers to the whole field declaration (from the beginning - of the label to the terminating semicolon). - - -.. _api_field_google.protobuf.SourceCodeInfo.Location.span: - -span - (`int32 `_) Always has exactly three or four elements: start line, start column, - end line (optional, otherwise assumed same as start line), end column. - These are packed into a single field for efficiency. Note that line - and column numbers are zero-based -- typically you will want to add - 1 to each before displaying to a user. - - -.. _api_field_google.protobuf.SourceCodeInfo.Location.leading_comments: - -leading_comments - (`string `_) If this SourceCodeInfo represents a complete declaration, these are any - comments appearing before and after the declaration which appear to be - attached to the declaration. - - A series of line comments appearing on consecutive lines, with no other - tokens appearing on those lines, will be treated as a single comment. - - leading_detached_comments will keep paragraphs of comments that appear - before (but not connected to) the current element. Each paragraph, - separated by empty lines, will be one comment element in the repeated - field. - - Only the comment content is provided; comment markers (e.g. //) are - stripped out. For block comments, leading whitespace and an asterisk - will be stripped from the beginning of each line other than the first. - Newlines are included in the output. - - Examples: - - optional int32 foo = 1; // Comment attached to foo. - // Comment attached to bar. - optional int32 bar = 2; - - optional string baz = 3; - // Comment attached to baz. - // Another line attached to baz. - - // Comment attached to qux. - // - // Another line attached to qux. - optional double qux = 4; - - // Detached comment for corge. This is not leading or trailing comments - // to qux or corge because there are blank lines separating it from - // both. - - // Detached comment for corge paragraph 2. - - optional string corge = 5; - /* Block comment attached - * to corge. Leading asterisks - * will be removed. */ - /* Block comment attached to - * grault. */ - optional int32 grault = 6; - - // ignored detached comments. - - -.. _api_field_google.protobuf.SourceCodeInfo.Location.trailing_comments: - -trailing_comments - (`string `_) - -.. _api_field_google.protobuf.SourceCodeInfo.Location.leading_detached_comments: - -leading_detached_comments - (`string `_) - - - - -.. _api_msg_google.protobuf.GeneratedCodeInfo: - -google.protobuf.GeneratedCodeInfo ---------------------------------- - -`[google.protobuf.GeneratedCodeInfo proto] `_ - -Describes the relationship between generated code and its original source -file. A GeneratedCodeInfo message is associated with only one generated -source file, but may contain references to different source .proto files. - -.. code-block:: json - - { - "annotation": [] - } - -.. _api_field_google.protobuf.GeneratedCodeInfo.annotation: - -annotation - (:ref:`google.protobuf.GeneratedCodeInfo.Annotation `) An Annotation connects some span of text in generated code to an element - of its generating .proto file. - - -.. _api_msg_google.protobuf.GeneratedCodeInfo.Annotation: - -google.protobuf.GeneratedCodeInfo.Annotation --------------------------------------------- - -`[google.protobuf.GeneratedCodeInfo.Annotation proto] `_ - - -.. code-block:: json - - { - "path": [], - "source_file": "...", - "begin": "...", - "end": "..." - } - -.. _api_field_google.protobuf.GeneratedCodeInfo.Annotation.path: - -path - (`int32 `_) Identifies the element in the original source .proto file. This field - is formatted the same as SourceCodeInfo.Location.path. - - -.. _api_field_google.protobuf.GeneratedCodeInfo.Annotation.source_file: - -source_file - (`string `_) Identifies the filesystem path to the original source .proto. - - -.. _api_field_google.protobuf.GeneratedCodeInfo.Annotation.begin: - -begin - (`int32 `_) Identifies the starting offset in bytes in the generated code - that relates to the identified object. - - -.. _api_field_google.protobuf.GeneratedCodeInfo.Annotation.end: - -end - (`int32 `_) Identifies the ending offset in bytes in the generated code that - relates to the identified offset. The end offset should be one past - the last relevant byte (so the length of the text = end - begin). - - - - diff --git a/flyteidl/gen/pb-protodoc/google/protobuf/duration.proto.rst b/flyteidl/gen/pb-protodoc/google/protobuf/duration.proto.rst deleted file mode 100644 index df78e8484c..0000000000 --- a/flyteidl/gen/pb-protodoc/google/protobuf/duration.proto.rst +++ /dev/null @@ -1,130 +0,0 @@ -.. _api_file_google/protobuf/duration.proto: - -duration.proto -============================== - -Protocol Buffers - Google's data interchange format -Copyright 2008 Google Inc. All rights reserved. -https://developers.google.com/protocol-buffers/ - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are -met: - - * Redistributions of source code must retain the above copyright -notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above -copyright notice, this list of conditions and the following disclaimer -in the documentation and/or other materials provided with the -distribution. - * Neither the name of Google Inc. nor the names of its -contributors may be used to endorse or promote products derived from -this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -.. _api_msg_google.protobuf.Duration: - -google.protobuf.Duration ------------------------- - -`[google.protobuf.Duration proto] `_ - -A Duration represents a signed, fixed-length span of time represented -as a count of seconds and fractions of seconds at nanosecond -resolution. It is independent of any calendar and concepts like "day" -or "month". It is related to Timestamp in that the difference between -two Timestamp values is a Duration and it can be added or subtracted -from a Timestamp. Range is approximately +-10,000 years. - -# Examples - -Example 1: Compute Duration from two Timestamps in pseudo code. - - Timestamp start = ...; - Timestamp end = ...; - Duration duration = ...; - - duration.seconds = end.seconds - start.seconds; - duration.nanos = end.nanos - start.nanos; - - if (duration.seconds < 0 && duration.nanos > 0) { - duration.seconds += 1; - duration.nanos -= 1000000000; - } else if (durations.seconds > 0 && duration.nanos < 0) { - duration.seconds -= 1; - duration.nanos += 1000000000; - } - -Example 2: Compute Timestamp from Timestamp + Duration in pseudo code. - - Timestamp start = ...; - Duration duration = ...; - Timestamp end = ...; - - end.seconds = start.seconds + duration.seconds; - end.nanos = start.nanos + duration.nanos; - - if (end.nanos < 0) { - end.seconds -= 1; - end.nanos += 1000000000; - } else if (end.nanos >= 1000000000) { - end.seconds += 1; - end.nanos -= 1000000000; - } - -Example 3: Compute Duration from datetime.timedelta in Python. - - td = datetime.timedelta(days=3, minutes=10) - duration = Duration() - duration.FromTimedelta(td) - -# JSON Mapping - -In JSON format, the Duration type is encoded as a string rather than an -object, where the string ends in the suffix "s" (indicating seconds) and -is preceded by the number of seconds, with nanoseconds expressed as -fractional seconds. For example, 3 seconds with 0 nanoseconds should be -encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should -be expressed in JSON format as "3.000000001s", and 3 seconds and 1 -microsecond should be expressed in JSON format as "3.000001s". - - - -.. code-block:: json - - { - "seconds": "...", - "nanos": "..." - } - -.. _api_field_google.protobuf.Duration.seconds: - -seconds - (`int64 `_) Signed seconds of the span of time. Must be from -315,576,000,000 - to +315,576,000,000 inclusive. Note: these bounds are computed from: - 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - - -.. _api_field_google.protobuf.Duration.nanos: - -nanos - (`int32 `_) Signed fractions of a second at nanosecond resolution of the span - of time. Durations less than one second are represented with a 0 - `seconds` field and a positive or negative `nanos` field. For durations - of one second or more, a non-zero value for the `nanos` field must be - of the same sign as the `seconds` field. Must be from -999,999,999 - to +999,999,999 inclusive. - - - diff --git a/flyteidl/gen/pb-protodoc/google/protobuf/index.rst b/flyteidl/gen/pb-protodoc/google/protobuf/index.rst deleted file mode 100644 index 26f8578496..0000000000 --- a/flyteidl/gen/pb-protodoc/google/protobuf/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -protobuf -======== - -.. toctree:: - :maxdepth: 1 - :caption: protobuf - :name: protobuftoc - - any.proto - descriptor.proto - duration.proto - struct.proto - timestamp.proto diff --git a/flyteidl/gen/pb-protodoc/google/protobuf/struct.proto.rst b/flyteidl/gen/pb-protodoc/google/protobuf/struct.proto.rst deleted file mode 100644 index 6627c46dca..0000000000 --- a/flyteidl/gen/pb-protodoc/google/protobuf/struct.proto.rst +++ /dev/null @@ -1,194 +0,0 @@ -.. _api_file_google/protobuf/struct.proto: - -struct.proto -============================ - -Protocol Buffers - Google's data interchange format -Copyright 2008 Google Inc. All rights reserved. -https://developers.google.com/protocol-buffers/ - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are -met: - - * Redistributions of source code must retain the above copyright -notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above -copyright notice, this list of conditions and the following disclaimer -in the documentation and/or other materials provided with the -distribution. - * Neither the name of Google Inc. nor the names of its -contributors may be used to endorse or promote products derived from -this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -.. _api_msg_google.protobuf.Struct: - -google.protobuf.Struct ----------------------- - -`[google.protobuf.Struct proto] `_ - -`Struct` represents a structured data value, consisting of fields -which map to dynamically typed values. In some languages, `Struct` -might be supported by a native representation. For example, in -scripting languages like JS a struct is represented as an -object. The details of that representation are described together -with the proto support for the language. - -The JSON representation for `Struct` is JSON object. - -.. code-block:: json - - { - "fields": "{...}" - } - -.. _api_field_google.protobuf.Struct.fields: - -fields - (map<`string `_, :ref:`google.protobuf.Value `>) Unordered map of dynamically typed values. - - - - -.. _api_msg_google.protobuf.Value: - -google.protobuf.Value ---------------------- - -`[google.protobuf.Value proto] `_ - -`Value` represents a dynamically typed value which can be either -null, a number, a string, a boolean, a recursive struct value, or a -list of values. A producer of value is expected to set one of that -variants, absence of any variant indicates an error. - -The JSON representation for `Value` is JSON value. - -.. code-block:: json - - { - "null_value": "...", - "number_value": "...", - "string_value": "...", - "bool_value": "...", - "struct_value": "{...}", - "list_value": "{...}" - } - -.. _api_field_google.protobuf.Value.null_value: - -null_value - (:ref:`google.protobuf.NullValue `) Represents a null value. - - The kind of value. - - - Only one of :ref:`null_value `, :ref:`number_value `, :ref:`string_value `, :ref:`bool_value `, :ref:`struct_value `, :ref:`list_value ` may be set. - -.. _api_field_google.protobuf.Value.number_value: - -number_value - (`double `_) Represents a double value. - - The kind of value. - - - Only one of :ref:`null_value `, :ref:`number_value `, :ref:`string_value `, :ref:`bool_value `, :ref:`struct_value `, :ref:`list_value ` may be set. - -.. _api_field_google.protobuf.Value.string_value: - -string_value - (`string `_) Represents a string value. - - The kind of value. - - - Only one of :ref:`null_value `, :ref:`number_value `, :ref:`string_value `, :ref:`bool_value `, :ref:`struct_value `, :ref:`list_value ` may be set. - -.. _api_field_google.protobuf.Value.bool_value: - -bool_value - (`bool `_) Represents a boolean value. - - The kind of value. - - - Only one of :ref:`null_value `, :ref:`number_value `, :ref:`string_value `, :ref:`bool_value `, :ref:`struct_value `, :ref:`list_value ` may be set. - -.. _api_field_google.protobuf.Value.struct_value: - -struct_value - (:ref:`google.protobuf.Struct `) Represents a structured value. - - The kind of value. - - - Only one of :ref:`null_value `, :ref:`number_value `, :ref:`string_value `, :ref:`bool_value `, :ref:`struct_value `, :ref:`list_value ` may be set. - -.. _api_field_google.protobuf.Value.list_value: - -list_value - (:ref:`google.protobuf.ListValue `) Represents a repeated `Value`. - - The kind of value. - - - Only one of :ref:`null_value `, :ref:`number_value `, :ref:`string_value `, :ref:`bool_value `, :ref:`struct_value `, :ref:`list_value ` may be set. - - - -.. _api_msg_google.protobuf.ListValue: - -google.protobuf.ListValue -------------------------- - -`[google.protobuf.ListValue proto] `_ - -`ListValue` is a wrapper around a repeated field of values. - -The JSON representation for `ListValue` is JSON array. - -.. code-block:: json - - { - "values": [] - } - -.. _api_field_google.protobuf.ListValue.values: - -values - (:ref:`google.protobuf.Value `) Repeated field of dynamically typed values. - - - -.. _api_enum_google.protobuf.NullValue: - -Enum google.protobuf.NullValue ------------------------------- - -`[google.protobuf.NullValue proto] `_ - -`NullValue` is a singleton enumeration to represent the null value for the -`Value` type union. - - The JSON representation for `NullValue` is JSON `null`. - -.. _api_enum_value_google.protobuf.NullValue.NULL_VALUE: - -NULL_VALUE - *(DEFAULT)* ⁣Null value. - - diff --git a/flyteidl/gen/pb-protodoc/google/protobuf/timestamp.proto.rst b/flyteidl/gen/pb-protodoc/google/protobuf/timestamp.proto.rst deleted file mode 100644 index 2a85d42542..0000000000 --- a/flyteidl/gen/pb-protodoc/google/protobuf/timestamp.proto.rst +++ /dev/null @@ -1,150 +0,0 @@ -.. _api_file_google/protobuf/timestamp.proto: - -timestamp.proto -=============================== - -Protocol Buffers - Google's data interchange format -Copyright 2008 Google Inc. All rights reserved. -https://developers.google.com/protocol-buffers/ - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are -met: - - * Redistributions of source code must retain the above copyright -notice, this list of conditions and the following disclaimer. - * Redistributions in binary form must reproduce the above -copyright notice, this list of conditions and the following disclaimer -in the documentation and/or other materials provided with the -distribution. - * Neither the name of Google Inc. nor the names of its -contributors may be used to endorse or promote products derived from -this software without specific prior written permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - -.. _api_msg_google.protobuf.Timestamp: - -google.protobuf.Timestamp -------------------------- - -`[google.protobuf.Timestamp proto] `_ - -A Timestamp represents a point in time independent of any time zone or local -calendar, encoded as a count of seconds and fractions of seconds at -nanosecond resolution. The count is relative to an epoch at UTC midnight on -January 1, 1970, in the proleptic Gregorian calendar which extends the -Gregorian calendar backwards to year one. - -All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap -second table is needed for interpretation, using a [24-hour linear -smear](https://developers.google.com/time/smear). - -The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By -restricting to that range, we ensure that we can convert to and from [RFC -3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. - -# Examples - -Example 1: Compute Timestamp from POSIX `time()`. - - Timestamp timestamp; - timestamp.set_seconds(time(NULL)); - timestamp.set_nanos(0); - -Example 2: Compute Timestamp from POSIX `gettimeofday()`. - - struct timeval tv; - gettimeofday(&tv, NULL); - - Timestamp timestamp; - timestamp.set_seconds(tv.tv_sec); - timestamp.set_nanos(tv.tv_usec * 1000); - -Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. - - FILETIME ft; - GetSystemTimeAsFileTime(&ft); - UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; - - // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z - // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. - Timestamp timestamp; - timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); - timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); - -Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. - - long millis = System.currentTimeMillis(); - - Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) - .setNanos((int) ((millis % 1000) * 1000000)).build(); - - -Example 5: Compute Timestamp from current time in Python. - - timestamp = Timestamp() - timestamp.GetCurrentTime() - -# JSON Mapping - -In JSON format, the Timestamp type is encoded as a string in the -[RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the -format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" -where {year} is always expressed using four digits while {month}, {day}, -{hour}, {min}, and {sec} are zero-padded to two digits each. The fractional -seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), -are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone -is required. A proto3 JSON serializer should always use UTC (as indicated by -"Z") when printing the Timestamp type and a proto3 JSON parser should be -able to accept both UTC and other timezones (as indicated by an offset). - -For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past -01:30 UTC on January 15, 2017. - -In JavaScript, one can convert a Date object to this format using the -standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) -method. In Python, a standard `datetime.datetime` object can be converted -to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) -with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one -can use the Joda Time's [`ISODateTimeFormat.dateTime()`]( -http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D -) to obtain a formatter capable of generating timestamps in this format. - - - -.. code-block:: json - - { - "seconds": "...", - "nanos": "..." - } - -.. _api_field_google.protobuf.Timestamp.seconds: - -seconds - (`int64 `_) Represents seconds of UTC time since Unix epoch - 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to - 9999-12-31T23:59:59Z inclusive. - - -.. _api_field_google.protobuf.Timestamp.nanos: - -nanos - (`int32 `_) Non-negative fractions of a second at nanosecond resolution. Negative - second values with fractions must still have non-negative nanos values - that count forward in time. Must be from 0 to 999,999,999 - inclusive. - - - diff --git a/flyteidl/gen/pb-protodoc/index.rst b/flyteidl/gen/pb-protodoc/index.rst deleted file mode 100644 index 039ef5b7af..0000000000 --- a/flyteidl/gen/pb-protodoc/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -pb-protodoc -=========== - -.. toctree:: - :maxdepth: 1 - :caption: pb-protodoc - :name: pb-protodoctoc - - flyteidl/index - google/index - k8s.io/index - protoc-gen-swagger/index diff --git a/flyteidl/gen/pb-protodoc/k8s.io/api/core/index.rst b/flyteidl/gen/pb-protodoc/k8s.io/api/core/index.rst deleted file mode 100644 index ea5e71b263..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/api/core/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -core -==== - -.. toctree:: - :maxdepth: 1 - :caption: core - :name: coretoc - - v1/index diff --git a/flyteidl/gen/pb-protodoc/k8s.io/api/core/v1/generated.proto.rst b/flyteidl/gen/pb-protodoc/k8s.io/api/core/v1/generated.proto.rst deleted file mode 100644 index 8798474b36..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/api/core/v1/generated.proto.rst +++ /dev/null @@ -1,10519 +0,0 @@ -.. _api_file_k8s.io/api/core/v1/generated.proto: - -generated.proto -================================== - - -opyright The Kubernetes Authors. - -icensed under the Apache License, Version 2.0 (the "License"); -ou may not use this file except in compliance with the License. -ou may obtain a copy of the License at - -ttp://www.apache.org/licenses/LICENSE-2.0 - -nless required by applicable law or agreed to in writing, software -istributed under the License is distributed on an "AS IS" BASIS, -ITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -ee the License for the specific language governing permissions and -imitations under the License. -This file was autogenerated by go-to-protobuf. Do not edit it manually! - -.. _api_msg_k8s.io.api.core.v1.AWSElasticBlockStoreVolumeSource: - -k8s.io.api.core.v1.AWSElasticBlockStoreVolumeSource ---------------------------------------------------- - -`[k8s.io.api.core.v1.AWSElasticBlockStoreVolumeSource proto] `_ - -Represents a Persistent Disk resource in AWS. - -An AWS EBS disk must exist before mounting to a container. The disk -must also be in the same AWS zone as the kubelet. An AWS EBS disk -can only be mounted as read/write once. AWS EBS volumes support -ownership management and SELinux relabeling. - -.. code-block:: json - - { - "volumeID": "...", - "fsType": "...", - "partition": "...", - "readOnly": "..." - } - -.. _api_field_k8s.io.api.core.v1.AWSElasticBlockStoreVolumeSource.volumeID: - -volumeID - (`string `_) Unique ID of the persistent disk resource in AWS (Amazon EBS volume). - More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore - - -.. _api_field_k8s.io.api.core.v1.AWSElasticBlockStoreVolumeSource.fsType: - -fsType - (`string `_) Filesystem type of the volume that you want to mount. - Tip: Ensure that the filesystem type is supported by the host operating system. - Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore - TODO: how do we prevent errors in the filesystem from compromising the machine - +optional - - -.. _api_field_k8s.io.api.core.v1.AWSElasticBlockStoreVolumeSource.partition: - -partition - (`int32 `_) The partition in the volume that you want to mount. - If omitted, the default is to mount by volume name. - Examples: For volume /dev/sda1, you specify the partition as "1". - Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). - +optional - - -.. _api_field_k8s.io.api.core.v1.AWSElasticBlockStoreVolumeSource.readOnly: - -readOnly - (`bool `_) Specify "true" to force and set the ReadOnly property in VolumeMounts to "true". - If omitted, the default is "false". - More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.Affinity: - -k8s.io.api.core.v1.Affinity ---------------------------- - -`[k8s.io.api.core.v1.Affinity proto] `_ - -Affinity is a group of affinity scheduling rules. - -.. code-block:: json - - { - "nodeAffinity": "{...}", - "podAffinity": "{...}", - "podAntiAffinity": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.Affinity.nodeAffinity: - -nodeAffinity - (:ref:`k8s.io.api.core.v1.NodeAffinity `) Describes node affinity scheduling rules for the pod. - +optional - - -.. _api_field_k8s.io.api.core.v1.Affinity.podAffinity: - -podAffinity - (:ref:`k8s.io.api.core.v1.PodAffinity `) Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)). - +optional - - -.. _api_field_k8s.io.api.core.v1.Affinity.podAntiAffinity: - -podAntiAffinity - (:ref:`k8s.io.api.core.v1.PodAntiAffinity `) Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)). - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.AttachedVolume: - -k8s.io.api.core.v1.AttachedVolume ---------------------------------- - -`[k8s.io.api.core.v1.AttachedVolume proto] `_ - -AttachedVolume describes a volume attached to a node - -.. code-block:: json - - { - "name": "...", - "devicePath": "..." - } - -.. _api_field_k8s.io.api.core.v1.AttachedVolume.name: - -name - (`string `_) Name of the attached volume - - -.. _api_field_k8s.io.api.core.v1.AttachedVolume.devicePath: - -devicePath - (`string `_) DevicePath represents the device path where the volume should be available - - - - -.. _api_msg_k8s.io.api.core.v1.AvoidPods: - -k8s.io.api.core.v1.AvoidPods ----------------------------- - -`[k8s.io.api.core.v1.AvoidPods proto] `_ - -AvoidPods describes pods that should avoid this node. This is the value for a -Node annotation with key scheduler.alpha.kubernetes.io/preferAvoidPods and -will eventually become a field of NodeStatus. - -.. code-block:: json - - { - "preferAvoidPods": [] - } - -.. _api_field_k8s.io.api.core.v1.AvoidPods.preferAvoidPods: - -preferAvoidPods - (:ref:`k8s.io.api.core.v1.PreferAvoidPodsEntry `) Bounded-sized list of signatures of pods that should avoid this node, sorted - in timestamp order from oldest to newest. Size of the slice is unspecified. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.AzureDiskVolumeSource: - -k8s.io.api.core.v1.AzureDiskVolumeSource ----------------------------------------- - -`[k8s.io.api.core.v1.AzureDiskVolumeSource proto] `_ - -AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. - -.. code-block:: json - - { - "diskName": "...", - "diskURI": "...", - "cachingMode": "...", - "fsType": "...", - "readOnly": "...", - "kind": "..." - } - -.. _api_field_k8s.io.api.core.v1.AzureDiskVolumeSource.diskName: - -diskName - (`string `_) The Name of the data disk in the blob storage - - -.. _api_field_k8s.io.api.core.v1.AzureDiskVolumeSource.diskURI: - -diskURI - (`string `_) The URI the data disk in the blob storage - - -.. _api_field_k8s.io.api.core.v1.AzureDiskVolumeSource.cachingMode: - -cachingMode - (`string `_) Host Caching mode: None, Read Only, Read Write. - +optional - - -.. _api_field_k8s.io.api.core.v1.AzureDiskVolumeSource.fsType: - -fsType - (`string `_) Filesystem type to mount. - Must be a filesystem type supported by the host operating system. - Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - +optional - - -.. _api_field_k8s.io.api.core.v1.AzureDiskVolumeSource.readOnly: - -readOnly - (`bool `_) Defaults to false (read/write). ReadOnly here will force - the ReadOnly setting in VolumeMounts. - +optional - - -.. _api_field_k8s.io.api.core.v1.AzureDiskVolumeSource.kind: - -kind - (`string `_) Expected values Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared - - - - -.. _api_msg_k8s.io.api.core.v1.AzureFilePersistentVolumeSource: - -k8s.io.api.core.v1.AzureFilePersistentVolumeSource --------------------------------------------------- - -`[k8s.io.api.core.v1.AzureFilePersistentVolumeSource proto] `_ - -AzureFile represents an Azure File Service mount on the host and bind mount to the pod. - -.. code-block:: json - - { - "secretName": "...", - "shareName": "...", - "readOnly": "...", - "secretNamespace": "..." - } - -.. _api_field_k8s.io.api.core.v1.AzureFilePersistentVolumeSource.secretName: - -secretName - (`string `_) the name of secret that contains Azure Storage Account Name and Key - - -.. _api_field_k8s.io.api.core.v1.AzureFilePersistentVolumeSource.shareName: - -shareName - (`string `_) Share Name - - -.. _api_field_k8s.io.api.core.v1.AzureFilePersistentVolumeSource.readOnly: - -readOnly - (`bool `_) Defaults to false (read/write). ReadOnly here will force - the ReadOnly setting in VolumeMounts. - +optional - - -.. _api_field_k8s.io.api.core.v1.AzureFilePersistentVolumeSource.secretNamespace: - -secretNamespace - (`string `_) the namespace of the secret that contains Azure Storage Account Name and Key - default is the same as the Pod - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.AzureFileVolumeSource: - -k8s.io.api.core.v1.AzureFileVolumeSource ----------------------------------------- - -`[k8s.io.api.core.v1.AzureFileVolumeSource proto] `_ - -AzureFile represents an Azure File Service mount on the host and bind mount to the pod. - -.. code-block:: json - - { - "secretName": "...", - "shareName": "...", - "readOnly": "..." - } - -.. _api_field_k8s.io.api.core.v1.AzureFileVolumeSource.secretName: - -secretName - (`string `_) the name of secret that contains Azure Storage Account Name and Key - - -.. _api_field_k8s.io.api.core.v1.AzureFileVolumeSource.shareName: - -shareName - (`string `_) Share Name - - -.. _api_field_k8s.io.api.core.v1.AzureFileVolumeSource.readOnly: - -readOnly - (`bool `_) Defaults to false (read/write). ReadOnly here will force - the ReadOnly setting in VolumeMounts. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.Binding: - -k8s.io.api.core.v1.Binding --------------------------- - -`[k8s.io.api.core.v1.Binding proto] `_ - -Binding ties one object to another; for example, a pod is bound to a node by a scheduler. -Deprecated in 1.7, please use the bindings subresource of pods instead. - -.. code-block:: json - - { - "metadata": "{...}", - "target": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.Binding.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.Binding.target: - -target - (:ref:`k8s.io.api.core.v1.ObjectReference `) The target object that you want to bind to the standard object. - - - - -.. _api_msg_k8s.io.api.core.v1.CSIPersistentVolumeSource: - -k8s.io.api.core.v1.CSIPersistentVolumeSource --------------------------------------------- - -`[k8s.io.api.core.v1.CSIPersistentVolumeSource proto] `_ - -Represents storage that is managed by an external CSI volume driver (Beta feature) - -.. code-block:: json - - { - "driver": "...", - "volumeHandle": "...", - "readOnly": "...", - "fsType": "...", - "volumeAttributes": "{...}", - "controllerPublishSecretRef": "{...}", - "nodeStageSecretRef": "{...}", - "nodePublishSecretRef": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.CSIPersistentVolumeSource.driver: - -driver - (`string `_) Driver is the name of the driver to use for this volume. - Required. - - -.. _api_field_k8s.io.api.core.v1.CSIPersistentVolumeSource.volumeHandle: - -volumeHandle - (`string `_) VolumeHandle is the unique volume name returned by the CSI volume - plugin’s CreateVolume to refer to the volume on all subsequent calls. - Required. - - -.. _api_field_k8s.io.api.core.v1.CSIPersistentVolumeSource.readOnly: - -readOnly - (`bool `_) Optional: The value to pass to ControllerPublishVolumeRequest. - Defaults to false (read/write). - +optional - - -.. _api_field_k8s.io.api.core.v1.CSIPersistentVolumeSource.fsType: - -fsType - (`string `_) Filesystem type to mount. - Must be a filesystem type supported by the host operating system. - Ex. "ext4", "xfs", "ntfs". - +optional - - -.. _api_field_k8s.io.api.core.v1.CSIPersistentVolumeSource.volumeAttributes: - -volumeAttributes - (map<`string `_, `string `_>) Attributes of the volume to publish. - +optional - - -.. _api_field_k8s.io.api.core.v1.CSIPersistentVolumeSource.controllerPublishSecretRef: - -controllerPublishSecretRef - (:ref:`k8s.io.api.core.v1.SecretReference `) ControllerPublishSecretRef is a reference to the secret object containing - sensitive information to pass to the CSI driver to complete the CSI - ControllerPublishVolume and ControllerUnpublishVolume calls. - This field is optional, and may be empty if no secret is required. If the - secret object contains more than one secret, all secrets are passed. - +optional - - -.. _api_field_k8s.io.api.core.v1.CSIPersistentVolumeSource.nodeStageSecretRef: - -nodeStageSecretRef - (:ref:`k8s.io.api.core.v1.SecretReference `) NodeStageSecretRef is a reference to the secret object containing sensitive - information to pass to the CSI driver to complete the CSI NodeStageVolume - and NodeStageVolume and NodeUnstageVolume calls. - This field is optional, and may be empty if no secret is required. If the - secret object contains more than one secret, all secrets are passed. - +optional - - -.. _api_field_k8s.io.api.core.v1.CSIPersistentVolumeSource.nodePublishSecretRef: - -nodePublishSecretRef - (:ref:`k8s.io.api.core.v1.SecretReference `) NodePublishSecretRef is a reference to the secret object containing - sensitive information to pass to the CSI driver to complete the CSI - NodePublishVolume and NodeUnpublishVolume calls. - This field is optional, and may be empty if no secret is required. If the - secret object contains more than one secret, all secrets are passed. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.CSIVolumeSource: - -k8s.io.api.core.v1.CSIVolumeSource ----------------------------------- - -`[k8s.io.api.core.v1.CSIVolumeSource proto] `_ - -Represents a source location of a volume to mount, managed by an external CSI driver - -.. code-block:: json - - { - "driver": "...", - "readOnly": "...", - "fsType": "...", - "volumeAttributes": "{...}", - "nodePublishSecretRef": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.CSIVolumeSource.driver: - -driver - (`string `_) Driver is the name of the CSI driver that handles this volume. - Consult with your admin for the correct name as registered in the cluster. - - -.. _api_field_k8s.io.api.core.v1.CSIVolumeSource.readOnly: - -readOnly - (`bool `_) Specifies a read-only configuration for the volume. - Defaults to false (read/write). - +optional - - -.. _api_field_k8s.io.api.core.v1.CSIVolumeSource.fsType: - -fsType - (`string `_) Filesystem type to mount. Ex. "ext4", "xfs", "ntfs". - If not provided, the empty value is passed to the associated CSI driver - which will determine the default filesystem to apply. - +optional - - -.. _api_field_k8s.io.api.core.v1.CSIVolumeSource.volumeAttributes: - -volumeAttributes - (map<`string `_, `string `_>) VolumeAttributes stores driver-specific properties that are passed to the CSI - driver. Consult your driver's documentation for supported values. - +optional - - -.. _api_field_k8s.io.api.core.v1.CSIVolumeSource.nodePublishSecretRef: - -nodePublishSecretRef - (:ref:`k8s.io.api.core.v1.LocalObjectReference `) NodePublishSecretRef is a reference to the secret object containing - sensitive information to pass to the CSI driver to complete the CSI - NodePublishVolume and NodeUnpublishVolume calls. - This field is optional, and may be empty if no secret is required. If the - secret object contains more than one secret, all secret references are passed. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.Capabilities: - -k8s.io.api.core.v1.Capabilities -------------------------------- - -`[k8s.io.api.core.v1.Capabilities proto] `_ - -Adds and removes POSIX capabilities from running containers. - -.. code-block:: json - - { - "add": [], - "drop": [] - } - -.. _api_field_k8s.io.api.core.v1.Capabilities.add: - -add - (`string `_) Added capabilities - +optional - - -.. _api_field_k8s.io.api.core.v1.Capabilities.drop: - -drop - (`string `_) Removed capabilities - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.CephFSPersistentVolumeSource: - -k8s.io.api.core.v1.CephFSPersistentVolumeSource ------------------------------------------------ - -`[k8s.io.api.core.v1.CephFSPersistentVolumeSource proto] `_ - -Represents a Ceph Filesystem mount that lasts the lifetime of a pod -Cephfs volumes do not support ownership management or SELinux relabeling. - -.. code-block:: json - - { - "monitors": [], - "path": "...", - "user": "...", - "secretFile": "...", - "secretRef": "{...}", - "readOnly": "..." - } - -.. _api_field_k8s.io.api.core.v1.CephFSPersistentVolumeSource.monitors: - -monitors - (`string `_) Required: Monitors is a collection of Ceph monitors - More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it - - -.. _api_field_k8s.io.api.core.v1.CephFSPersistentVolumeSource.path: - -path - (`string `_) Optional: Used as the mounted root, rather than the full Ceph tree, default is / - +optional - - -.. _api_field_k8s.io.api.core.v1.CephFSPersistentVolumeSource.user: - -user - (`string `_) Optional: User is the rados user name, default is admin - More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it - +optional - - -.. _api_field_k8s.io.api.core.v1.CephFSPersistentVolumeSource.secretFile: - -secretFile - (`string `_) Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret - More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it - +optional - - -.. _api_field_k8s.io.api.core.v1.CephFSPersistentVolumeSource.secretRef: - -secretRef - (:ref:`k8s.io.api.core.v1.SecretReference `) Optional: SecretRef is reference to the authentication secret for User, default is empty. - More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it - +optional - - -.. _api_field_k8s.io.api.core.v1.CephFSPersistentVolumeSource.readOnly: - -readOnly - (`bool `_) Optional: Defaults to false (read/write). ReadOnly here will force - the ReadOnly setting in VolumeMounts. - More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.CephFSVolumeSource: - -k8s.io.api.core.v1.CephFSVolumeSource -------------------------------------- - -`[k8s.io.api.core.v1.CephFSVolumeSource proto] `_ - -Represents a Ceph Filesystem mount that lasts the lifetime of a pod -Cephfs volumes do not support ownership management or SELinux relabeling. - -.. code-block:: json - - { - "monitors": [], - "path": "...", - "user": "...", - "secretFile": "...", - "secretRef": "{...}", - "readOnly": "..." - } - -.. _api_field_k8s.io.api.core.v1.CephFSVolumeSource.monitors: - -monitors - (`string `_) Required: Monitors is a collection of Ceph monitors - More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it - - -.. _api_field_k8s.io.api.core.v1.CephFSVolumeSource.path: - -path - (`string `_) Optional: Used as the mounted root, rather than the full Ceph tree, default is / - +optional - - -.. _api_field_k8s.io.api.core.v1.CephFSVolumeSource.user: - -user - (`string `_) Optional: User is the rados user name, default is admin - More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it - +optional - - -.. _api_field_k8s.io.api.core.v1.CephFSVolumeSource.secretFile: - -secretFile - (`string `_) Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret - More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it - +optional - - -.. _api_field_k8s.io.api.core.v1.CephFSVolumeSource.secretRef: - -secretRef - (:ref:`k8s.io.api.core.v1.LocalObjectReference `) Optional: SecretRef is reference to the authentication secret for User, default is empty. - More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it - +optional - - -.. _api_field_k8s.io.api.core.v1.CephFSVolumeSource.readOnly: - -readOnly - (`bool `_) Optional: Defaults to false (read/write). ReadOnly here will force - the ReadOnly setting in VolumeMounts. - More info: https://releases.k8s.io/HEAD/examples/volumes/cephfs/README.md#how-to-use-it - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.CinderPersistentVolumeSource: - -k8s.io.api.core.v1.CinderPersistentVolumeSource ------------------------------------------------ - -`[k8s.io.api.core.v1.CinderPersistentVolumeSource proto] `_ - -Represents a cinder volume resource in Openstack. -A Cinder volume must exist before mounting to a container. -The volume must also be in the same region as the kubelet. -Cinder volumes support ownership management and SELinux relabeling. - -.. code-block:: json - - { - "volumeID": "...", - "fsType": "...", - "readOnly": "...", - "secretRef": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.CinderPersistentVolumeSource.volumeID: - -volumeID - (`string `_) volume id used to identify the volume in cinder - More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md - - -.. _api_field_k8s.io.api.core.v1.CinderPersistentVolumeSource.fsType: - -fsType - (`string `_) Filesystem type to mount. - Must be a filesystem type supported by the host operating system. - Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md - +optional - - -.. _api_field_k8s.io.api.core.v1.CinderPersistentVolumeSource.readOnly: - -readOnly - (`bool `_) Optional: Defaults to false (read/write). ReadOnly here will force - the ReadOnly setting in VolumeMounts. - More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md - +optional - - -.. _api_field_k8s.io.api.core.v1.CinderPersistentVolumeSource.secretRef: - -secretRef - (:ref:`k8s.io.api.core.v1.SecretReference `) Optional: points to a secret object containing parameters used to connect - to OpenStack. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.CinderVolumeSource: - -k8s.io.api.core.v1.CinderVolumeSource -------------------------------------- - -`[k8s.io.api.core.v1.CinderVolumeSource proto] `_ - -Represents a cinder volume resource in Openstack. -A Cinder volume must exist before mounting to a container. -The volume must also be in the same region as the kubelet. -Cinder volumes support ownership management and SELinux relabeling. - -.. code-block:: json - - { - "volumeID": "...", - "fsType": "...", - "readOnly": "...", - "secretRef": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.CinderVolumeSource.volumeID: - -volumeID - (`string `_) volume id used to identify the volume in cinder - More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md - - -.. _api_field_k8s.io.api.core.v1.CinderVolumeSource.fsType: - -fsType - (`string `_) Filesystem type to mount. - Must be a filesystem type supported by the host operating system. - Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md - +optional - - -.. _api_field_k8s.io.api.core.v1.CinderVolumeSource.readOnly: - -readOnly - (`bool `_) Optional: Defaults to false (read/write). ReadOnly here will force - the ReadOnly setting in VolumeMounts. - More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md - +optional - - -.. _api_field_k8s.io.api.core.v1.CinderVolumeSource.secretRef: - -secretRef - (:ref:`k8s.io.api.core.v1.LocalObjectReference `) Optional: points to a secret object containing parameters used to connect - to OpenStack. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ClientIPConfig: - -k8s.io.api.core.v1.ClientIPConfig ---------------------------------- - -`[k8s.io.api.core.v1.ClientIPConfig proto] `_ - -ClientIPConfig represents the configurations of Client IP based session affinity. - -.. code-block:: json - - { - "timeoutSeconds": "..." - } - -.. _api_field_k8s.io.api.core.v1.ClientIPConfig.timeoutSeconds: - -timeoutSeconds - (`int32 `_) timeoutSeconds specifies the seconds of ClientIP type session sticky time. - The value must be >0 && <=86400(for 1 day) if ServiceAffinity == "ClientIP". - Default value is 10800(for 3 hours). - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ComponentCondition: - -k8s.io.api.core.v1.ComponentCondition -------------------------------------- - -`[k8s.io.api.core.v1.ComponentCondition proto] `_ - -Information about the condition of a component. - -.. code-block:: json - - { - "type": "...", - "status": "...", - "message": "...", - "error": "..." - } - -.. _api_field_k8s.io.api.core.v1.ComponentCondition.type: - -type - (`string `_) Type of condition for a component. - Valid value: "Healthy" - - -.. _api_field_k8s.io.api.core.v1.ComponentCondition.status: - -status - (`string `_) Status of the condition for a component. - Valid values for "Healthy": "True", "False", or "Unknown". - - -.. _api_field_k8s.io.api.core.v1.ComponentCondition.message: - -message - (`string `_) Message about the condition for a component. - For example, information about a health check. - +optional - - -.. _api_field_k8s.io.api.core.v1.ComponentCondition.error: - -error - (`string `_) Condition error code for a component. - For example, a health check error code. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ComponentStatus: - -k8s.io.api.core.v1.ComponentStatus ----------------------------------- - -`[k8s.io.api.core.v1.ComponentStatus proto] `_ - -ComponentStatus (and ComponentStatusList) holds the cluster validation info. - -.. code-block:: json - - { - "metadata": "{...}", - "conditions": [] - } - -.. _api_field_k8s.io.api.core.v1.ComponentStatus.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.ComponentStatus.conditions: - -conditions - (:ref:`k8s.io.api.core.v1.ComponentCondition `) List of component conditions observed - +optional - +patchMergeKey=type - +patchStrategy=merge - - - - -.. _api_msg_k8s.io.api.core.v1.ComponentStatusList: - -k8s.io.api.core.v1.ComponentStatusList --------------------------------------- - -`[k8s.io.api.core.v1.ComponentStatusList proto] `_ - -Status of all the conditions for the component as a list of ComponentStatus objects. - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.ComponentStatusList.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.api.core.v1.ComponentStatusList.items: - -items - (:ref:`k8s.io.api.core.v1.ComponentStatus `) List of ComponentStatus objects. - - - - -.. _api_msg_k8s.io.api.core.v1.ConfigMap: - -k8s.io.api.core.v1.ConfigMap ----------------------------- - -`[k8s.io.api.core.v1.ConfigMap proto] `_ - -ConfigMap holds configuration data for pods to consume. - -.. code-block:: json - - { - "metadata": "{...}", - "data": "{...}", - "binaryData": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.ConfigMap.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.ConfigMap.data: - -data - (map<`string `_, `string `_>) Data contains the configuration data. - Each key must consist of alphanumeric characters, '-', '_' or '.'. - Values with non-UTF-8 byte sequences must use the BinaryData field. - The keys stored in Data must not overlap with the keys in - the BinaryData field, this is enforced during validation process. - +optional - - -.. _api_field_k8s.io.api.core.v1.ConfigMap.binaryData: - -binaryData - (map<`string `_, `bytes `_>) BinaryData contains the binary data. - Each key must consist of alphanumeric characters, '-', '_' or '.'. - BinaryData can contain byte sequences that are not in the UTF-8 range. - The keys stored in BinaryData must not overlap with the ones in - the Data field, this is enforced during validation process. - Using this field will require 1.10+ apiserver and - kubelet. - +optional - - - - - -.. _api_msg_k8s.io.api.core.v1.ConfigMapEnvSource: - -k8s.io.api.core.v1.ConfigMapEnvSource -------------------------------------- - -`[k8s.io.api.core.v1.ConfigMapEnvSource proto] `_ - -ConfigMapEnvSource selects a ConfigMap to populate the environment -variables with. - -The contents of the target ConfigMap's Data field will represent the -key-value pairs as environment variables. - -.. code-block:: json - - { - "localObjectReference": "{...}", - "optional": "..." - } - -.. _api_field_k8s.io.api.core.v1.ConfigMapEnvSource.localObjectReference: - -localObjectReference - (:ref:`k8s.io.api.core.v1.LocalObjectReference `) The ConfigMap to select from. - - -.. _api_field_k8s.io.api.core.v1.ConfigMapEnvSource.optional: - -optional - (`bool `_) Specify whether the ConfigMap must be defined - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ConfigMapKeySelector: - -k8s.io.api.core.v1.ConfigMapKeySelector ---------------------------------------- - -`[k8s.io.api.core.v1.ConfigMapKeySelector proto] `_ - -Selects a key from a ConfigMap. - -.. code-block:: json - - { - "localObjectReference": "{...}", - "key": "...", - "optional": "..." - } - -.. _api_field_k8s.io.api.core.v1.ConfigMapKeySelector.localObjectReference: - -localObjectReference - (:ref:`k8s.io.api.core.v1.LocalObjectReference `) The ConfigMap to select from. - - -.. _api_field_k8s.io.api.core.v1.ConfigMapKeySelector.key: - -key - (`string `_) The key to select. - - -.. _api_field_k8s.io.api.core.v1.ConfigMapKeySelector.optional: - -optional - (`bool `_) Specify whether the ConfigMap or it's key must be defined - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ConfigMapList: - -k8s.io.api.core.v1.ConfigMapList --------------------------------- - -`[k8s.io.api.core.v1.ConfigMapList proto] `_ - -ConfigMapList is a resource containing a list of ConfigMap objects. - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.ConfigMapList.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.ConfigMapList.items: - -items - (:ref:`k8s.io.api.core.v1.ConfigMap `) Items is the list of ConfigMaps. - - - - -.. _api_msg_k8s.io.api.core.v1.ConfigMapNodeConfigSource: - -k8s.io.api.core.v1.ConfigMapNodeConfigSource --------------------------------------------- - -`[k8s.io.api.core.v1.ConfigMapNodeConfigSource proto] `_ - -ConfigMapNodeConfigSource contains the information to reference a ConfigMap as a config source for the Node. - -.. code-block:: json - - { - "namespace": "...", - "name": "...", - "uid": "...", - "resourceVersion": "...", - "kubeletConfigKey": "..." - } - -.. _api_field_k8s.io.api.core.v1.ConfigMapNodeConfigSource.namespace: - -namespace - (`string `_) Namespace is the metadata.namespace of the referenced ConfigMap. - This field is required in all cases. - - -.. _api_field_k8s.io.api.core.v1.ConfigMapNodeConfigSource.name: - -name - (`string `_) Name is the metadata.name of the referenced ConfigMap. - This field is required in all cases. - - -.. _api_field_k8s.io.api.core.v1.ConfigMapNodeConfigSource.uid: - -uid - (`string `_) UID is the metadata.UID of the referenced ConfigMap. - This field is forbidden in Node.Spec, and required in Node.Status. - +optional - - -.. _api_field_k8s.io.api.core.v1.ConfigMapNodeConfigSource.resourceVersion: - -resourceVersion - (`string `_) ResourceVersion is the metadata.ResourceVersion of the referenced ConfigMap. - This field is forbidden in Node.Spec, and required in Node.Status. - +optional - - -.. _api_field_k8s.io.api.core.v1.ConfigMapNodeConfigSource.kubeletConfigKey: - -kubeletConfigKey - (`string `_) KubeletConfigKey declares which key of the referenced ConfigMap corresponds to the KubeletConfiguration structure - This field is required in all cases. - - - - -.. _api_msg_k8s.io.api.core.v1.ConfigMapProjection: - -k8s.io.api.core.v1.ConfigMapProjection --------------------------------------- - -`[k8s.io.api.core.v1.ConfigMapProjection proto] `_ - -Adapts a ConfigMap into a projected volume. - -The contents of the target ConfigMap's Data field will be presented in a -projected volume as files using the keys in the Data field as the file names, -unless the items element is populated with specific mappings of keys to paths. -Note that this is identical to a configmap volume source without the default -mode. - -.. code-block:: json - - { - "localObjectReference": "{...}", - "items": [], - "optional": "..." - } - -.. _api_field_k8s.io.api.core.v1.ConfigMapProjection.localObjectReference: - -localObjectReference - (:ref:`k8s.io.api.core.v1.LocalObjectReference `) - -.. _api_field_k8s.io.api.core.v1.ConfigMapProjection.items: - -items - (:ref:`k8s.io.api.core.v1.KeyToPath `) If unspecified, each key-value pair in the Data field of the referenced - ConfigMap will be projected into the volume as a file whose name is the - key and content is the value. If specified, the listed keys will be - projected into the specified paths, and unlisted keys will not be - present. If a key is specified which is not present in the ConfigMap, - the volume setup will error unless it is marked optional. Paths must be - relative and may not contain the '..' path or start with '..'. - +optional - - -.. _api_field_k8s.io.api.core.v1.ConfigMapProjection.optional: - -optional - (`bool `_) Specify whether the ConfigMap or it's keys must be defined - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ConfigMapVolumeSource: - -k8s.io.api.core.v1.ConfigMapVolumeSource ----------------------------------------- - -`[k8s.io.api.core.v1.ConfigMapVolumeSource proto] `_ - -Adapts a ConfigMap into a volume. - -The contents of the target ConfigMap's Data field will be presented in a -volume as files using the keys in the Data field as the file names, unless -the items element is populated with specific mappings of keys to paths. -ConfigMap volumes support ownership management and SELinux relabeling. - -.. code-block:: json - - { - "localObjectReference": "{...}", - "items": [], - "defaultMode": "...", - "optional": "..." - } - -.. _api_field_k8s.io.api.core.v1.ConfigMapVolumeSource.localObjectReference: - -localObjectReference - (:ref:`k8s.io.api.core.v1.LocalObjectReference `) - -.. _api_field_k8s.io.api.core.v1.ConfigMapVolumeSource.items: - -items - (:ref:`k8s.io.api.core.v1.KeyToPath `) If unspecified, each key-value pair in the Data field of the referenced - ConfigMap will be projected into the volume as a file whose name is the - key and content is the value. If specified, the listed keys will be - projected into the specified paths, and unlisted keys will not be - present. If a key is specified which is not present in the ConfigMap, - the volume setup will error unless it is marked optional. Paths must be - relative and may not contain the '..' path or start with '..'. - +optional - - -.. _api_field_k8s.io.api.core.v1.ConfigMapVolumeSource.defaultMode: - -defaultMode - (`int32 `_) Optional: mode bits to use on created files by default. Must be a - value between 0 and 0777. Defaults to 0644. - Directories within the path are not affected by this setting. - This might be in conflict with other options that affect the file - mode, like fsGroup, and the result can be other mode bits set. - +optional - - -.. _api_field_k8s.io.api.core.v1.ConfigMapVolumeSource.optional: - -optional - (`bool `_) Specify whether the ConfigMap or it's keys must be defined - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.Container: - -k8s.io.api.core.v1.Container ----------------------------- - -`[k8s.io.api.core.v1.Container proto] `_ - -A single application container that you want to run within a pod. - -.. code-block:: json - - { - "name": "...", - "image": "...", - "command": [], - "args": [], - "workingDir": "...", - "ports": [], - "envFrom": [], - "env": [], - "resources": "{...}", - "volumeMounts": [], - "volumeDevices": [], - "livenessProbe": "{...}", - "readinessProbe": "{...}", - "lifecycle": "{...}", - "terminationMessagePath": "...", - "terminationMessagePolicy": "...", - "imagePullPolicy": "...", - "securityContext": "{...}", - "stdin": "...", - "stdinOnce": "...", - "tty": "..." - } - -.. _api_field_k8s.io.api.core.v1.Container.name: - -name - (`string `_) Name of the container specified as a DNS_LABEL. - Each container in a pod must have a unique name (DNS_LABEL). - Cannot be updated. - - -.. _api_field_k8s.io.api.core.v1.Container.image: - -image - (`string `_) Docker image name. - More info: https://kubernetes.io/docs/concepts/containers/images - This field is optional to allow higher level config management to default or override - container images in workload controllers like Deployments and StatefulSets. - +optional - - -.. _api_field_k8s.io.api.core.v1.Container.command: - -command - (`string `_) Entrypoint array. Not executed within a shell. - The docker image's ENTRYPOINT is used if this is not provided. - Variable references $(VAR_NAME) are expanded using the container's environment. If a variable - cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax - can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, - regardless of whether the variable exists or not. - Cannot be updated. - More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell - +optional - - -.. _api_field_k8s.io.api.core.v1.Container.args: - -args - (`string `_) Arguments to the entrypoint. - The docker image's CMD is used if this is not provided. - Variable references $(VAR_NAME) are expanded using the container's environment. If a variable - cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax - can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, - regardless of whether the variable exists or not. - Cannot be updated. - More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell - +optional - - -.. _api_field_k8s.io.api.core.v1.Container.workingDir: - -workingDir - (`string `_) Container's working directory. - If not specified, the container runtime's default will be used, which - might be configured in the container image. - Cannot be updated. - +optional - - -.. _api_field_k8s.io.api.core.v1.Container.ports: - -ports - (:ref:`k8s.io.api.core.v1.ContainerPort `) List of ports to expose from the container. Exposing a port here gives - the system additional information about the network connections a - container uses, but is primarily informational. Not specifying a port here - DOES NOT prevent that port from being exposed. Any port which is - listening on the default "0.0.0.0" address inside a container will be - accessible from the network. - Cannot be updated. - +optional - +patchMergeKey=containerPort - +patchStrategy=merge - +listType=map - +listMapKey=containerPort - +listMapKey=protocol - - -.. _api_field_k8s.io.api.core.v1.Container.envFrom: - -envFrom - (:ref:`k8s.io.api.core.v1.EnvFromSource `) List of sources to populate environment variables in the container. - The keys defined within a source must be a C_IDENTIFIER. All invalid keys - will be reported as an event when the container is starting. When a key exists in multiple - sources, the value associated with the last source will take precedence. - Values defined by an Env with a duplicate key will take precedence. - Cannot be updated. - +optional - - -.. _api_field_k8s.io.api.core.v1.Container.env: - -env - (:ref:`k8s.io.api.core.v1.EnvVar `) List of environment variables to set in the container. - Cannot be updated. - +optional - +patchMergeKey=name - +patchStrategy=merge - - -.. _api_field_k8s.io.api.core.v1.Container.resources: - -resources - (:ref:`k8s.io.api.core.v1.ResourceRequirements `) Compute Resources required by this container. - Cannot be updated. - More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ - +optional - - -.. _api_field_k8s.io.api.core.v1.Container.volumeMounts: - -volumeMounts - (:ref:`k8s.io.api.core.v1.VolumeMount `) Pod volumes to mount into the container's filesystem. - Cannot be updated. - +optional - +patchMergeKey=mountPath - +patchStrategy=merge - - -.. _api_field_k8s.io.api.core.v1.Container.volumeDevices: - -volumeDevices - (:ref:`k8s.io.api.core.v1.VolumeDevice `) volumeDevices is the list of block devices to be used by the container. - This is a beta feature. - +patchMergeKey=devicePath - +patchStrategy=merge - +optional - - -.. _api_field_k8s.io.api.core.v1.Container.livenessProbe: - -livenessProbe - (:ref:`k8s.io.api.core.v1.Probe `) Periodic probe of container liveness. - Container will be restarted if the probe fails. - Cannot be updated. - More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - +optional - - -.. _api_field_k8s.io.api.core.v1.Container.readinessProbe: - -readinessProbe - (:ref:`k8s.io.api.core.v1.Probe `) Periodic probe of container service readiness. - Container will be removed from service endpoints if the probe fails. - Cannot be updated. - More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - +optional - - -.. _api_field_k8s.io.api.core.v1.Container.lifecycle: - -lifecycle - (:ref:`k8s.io.api.core.v1.Lifecycle `) Actions that the management system should take in response to container lifecycle events. - Cannot be updated. - +optional - - -.. _api_field_k8s.io.api.core.v1.Container.terminationMessagePath: - -terminationMessagePath - (`string `_) Optional: Path at which the file to which the container's termination message - will be written is mounted into the container's filesystem. - Message written is intended to be brief final status, such as an assertion failure message. - Will be truncated by the node if greater than 4096 bytes. The total message length across - all containers will be limited to 12kb. - Defaults to /dev/termination-log. - Cannot be updated. - +optional - - -.. _api_field_k8s.io.api.core.v1.Container.terminationMessagePolicy: - -terminationMessagePolicy - (`string `_) Indicate how the termination message should be populated. File will use the contents of - terminationMessagePath to populate the container status message on both success and failure. - FallbackToLogsOnError will use the last chunk of container log output if the termination - message file is empty and the container exited with an error. - The log output is limited to 2048 bytes or 80 lines, whichever is smaller. - Defaults to File. - Cannot be updated. - +optional - - -.. _api_field_k8s.io.api.core.v1.Container.imagePullPolicy: - -imagePullPolicy - (`string `_) Image pull policy. - One of Always, Never, IfNotPresent. - Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. - Cannot be updated. - More info: https://kubernetes.io/docs/concepts/containers/images#updating-images - +optional - - -.. _api_field_k8s.io.api.core.v1.Container.securityContext: - -securityContext - (:ref:`k8s.io.api.core.v1.SecurityContext `) Security options the pod should run with. - More info: https://kubernetes.io/docs/concepts/policy/security-context/ - More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ - +optional - - -.. _api_field_k8s.io.api.core.v1.Container.stdin: - -stdin - (`bool `_) Whether this container should allocate a buffer for stdin in the container runtime. If this - is not set, reads from stdin in the container will always result in EOF. - Default is false. - +optional - - -.. _api_field_k8s.io.api.core.v1.Container.stdinOnce: - -stdinOnce - (`bool `_) Whether the container runtime should close the stdin channel after it has been opened by - a single attach. When stdin is true the stdin stream will remain open across multiple attach - sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the - first client attaches to stdin, and then remains open and accepts data until the client disconnects, - at which time stdin is closed and remains closed until the container is restarted. If this - flag is false, a container processes that reads from stdin will never receive an EOF. - Default is false - +optional - - -.. _api_field_k8s.io.api.core.v1.Container.tty: - -tty - (`bool `_) Whether this container should allocate a TTY for itself, also requires 'stdin' to be true. - Default is false. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ContainerImage: - -k8s.io.api.core.v1.ContainerImage ---------------------------------- - -`[k8s.io.api.core.v1.ContainerImage proto] `_ - -Describe a container image - -.. code-block:: json - - { - "names": [], - "sizeBytes": "..." - } - -.. _api_field_k8s.io.api.core.v1.ContainerImage.names: - -names - (`string `_) Names by which this image is known. - e.g. ["k8s.gcr.io/hyperkube:v1.0.7", "dockerhub.io/google_containers/hyperkube:v1.0.7"] - - -.. _api_field_k8s.io.api.core.v1.ContainerImage.sizeBytes: - -sizeBytes - (`int64 `_) The size of the image in bytes. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ContainerPort: - -k8s.io.api.core.v1.ContainerPort --------------------------------- - -`[k8s.io.api.core.v1.ContainerPort proto] `_ - -ContainerPort represents a network port in a single container. - -.. code-block:: json - - { - "name": "...", - "hostPort": "...", - "containerPort": "...", - "protocol": "...", - "hostIP": "..." - } - -.. _api_field_k8s.io.api.core.v1.ContainerPort.name: - -name - (`string `_) If specified, this must be an IANA_SVC_NAME and unique within the pod. Each - named port in a pod must have a unique name. Name for the port that can be - referred to by services. - +optional - - -.. _api_field_k8s.io.api.core.v1.ContainerPort.hostPort: - -hostPort - (`int32 `_) Number of port to expose on the host. - If specified, this must be a valid port number, 0 < x < 65536. - If HostNetwork is specified, this must match ContainerPort. - Most containers do not need this. - +optional - - -.. _api_field_k8s.io.api.core.v1.ContainerPort.containerPort: - -containerPort - (`int32 `_) Number of port to expose on the pod's IP address. - This must be a valid port number, 0 < x < 65536. - - -.. _api_field_k8s.io.api.core.v1.ContainerPort.protocol: - -protocol - (`string `_) Protocol for port. Must be UDP, TCP, or SCTP. - Defaults to "TCP". - +optional - - -.. _api_field_k8s.io.api.core.v1.ContainerPort.hostIP: - -hostIP - (`string `_) What host IP to bind the external port to. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ContainerState: - -k8s.io.api.core.v1.ContainerState ---------------------------------- - -`[k8s.io.api.core.v1.ContainerState proto] `_ - -ContainerState holds a possible state of container. -Only one of its members may be specified. -If none of them is specified, the default one is ContainerStateWaiting. - -.. code-block:: json - - { - "waiting": "{...}", - "running": "{...}", - "terminated": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.ContainerState.waiting: - -waiting - (:ref:`k8s.io.api.core.v1.ContainerStateWaiting `) Details about a waiting container - +optional - - -.. _api_field_k8s.io.api.core.v1.ContainerState.running: - -running - (:ref:`k8s.io.api.core.v1.ContainerStateRunning `) Details about a running container - +optional - - -.. _api_field_k8s.io.api.core.v1.ContainerState.terminated: - -terminated - (:ref:`k8s.io.api.core.v1.ContainerStateTerminated `) Details about a terminated container - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ContainerStateRunning: - -k8s.io.api.core.v1.ContainerStateRunning ----------------------------------------- - -`[k8s.io.api.core.v1.ContainerStateRunning proto] `_ - -ContainerStateRunning is a running state of a container. - -.. code-block:: json - - { - "startedAt": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.ContainerStateRunning.startedAt: - -startedAt - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) Time at which the container was last (re-)started - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ContainerStateTerminated: - -k8s.io.api.core.v1.ContainerStateTerminated -------------------------------------------- - -`[k8s.io.api.core.v1.ContainerStateTerminated proto] `_ - -ContainerStateTerminated is a terminated state of a container. - -.. code-block:: json - - { - "exitCode": "...", - "signal": "...", - "reason": "...", - "message": "...", - "startedAt": "{...}", - "finishedAt": "{...}", - "containerID": "..." - } - -.. _api_field_k8s.io.api.core.v1.ContainerStateTerminated.exitCode: - -exitCode - (`int32 `_) Exit status from the last termination of the container - - -.. _api_field_k8s.io.api.core.v1.ContainerStateTerminated.signal: - -signal - (`int32 `_) Signal from the last termination of the container - +optional - - -.. _api_field_k8s.io.api.core.v1.ContainerStateTerminated.reason: - -reason - (`string `_) (brief) reason from the last termination of the container - +optional - - -.. _api_field_k8s.io.api.core.v1.ContainerStateTerminated.message: - -message - (`string `_) Message regarding the last termination of the container - +optional - - -.. _api_field_k8s.io.api.core.v1.ContainerStateTerminated.startedAt: - -startedAt - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) Time at which previous execution of the container started - +optional - - -.. _api_field_k8s.io.api.core.v1.ContainerStateTerminated.finishedAt: - -finishedAt - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) Time at which the container last terminated - +optional - - -.. _api_field_k8s.io.api.core.v1.ContainerStateTerminated.containerID: - -containerID - (`string `_) Container's ID in the format 'docker://' - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ContainerStateWaiting: - -k8s.io.api.core.v1.ContainerStateWaiting ----------------------------------------- - -`[k8s.io.api.core.v1.ContainerStateWaiting proto] `_ - -ContainerStateWaiting is a waiting state of a container. - -.. code-block:: json - - { - "reason": "...", - "message": "..." - } - -.. _api_field_k8s.io.api.core.v1.ContainerStateWaiting.reason: - -reason - (`string `_) (brief) reason the container is not yet running. - +optional - - -.. _api_field_k8s.io.api.core.v1.ContainerStateWaiting.message: - -message - (`string `_) Message regarding why the container is not yet running. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ContainerStatus: - -k8s.io.api.core.v1.ContainerStatus ----------------------------------- - -`[k8s.io.api.core.v1.ContainerStatus proto] `_ - -ContainerStatus contains details for the current status of this container. - -.. code-block:: json - - { - "name": "...", - "state": "{...}", - "lastState": "{...}", - "ready": "...", - "restartCount": "...", - "image": "...", - "imageID": "...", - "containerID": "..." - } - -.. _api_field_k8s.io.api.core.v1.ContainerStatus.name: - -name - (`string `_) This must be a DNS_LABEL. Each container in a pod must have a unique name. - Cannot be updated. - - -.. _api_field_k8s.io.api.core.v1.ContainerStatus.state: - -state - (:ref:`k8s.io.api.core.v1.ContainerState `) Details about the container's current condition. - +optional - - -.. _api_field_k8s.io.api.core.v1.ContainerStatus.lastState: - -lastState - (:ref:`k8s.io.api.core.v1.ContainerState `) Details about the container's last termination condition. - +optional - - -.. _api_field_k8s.io.api.core.v1.ContainerStatus.ready: - -ready - (`bool `_) Specifies whether the container has passed its readiness probe. - - -.. _api_field_k8s.io.api.core.v1.ContainerStatus.restartCount: - -restartCount - (`int32 `_) The number of times the container has been restarted, currently based on - the number of dead containers that have not yet been removed. - Note that this is calculated from dead containers. But those containers are subject to - garbage collection. This value will get capped at 5 by GC. - - -.. _api_field_k8s.io.api.core.v1.ContainerStatus.image: - -image - (`string `_) The image the container is running. - More info: https://kubernetes.io/docs/concepts/containers/images - TODO(dchen1107): Which image the container is running with? - - -.. _api_field_k8s.io.api.core.v1.ContainerStatus.imageID: - -imageID - (`string `_) ImageID of the container's image. - - -.. _api_field_k8s.io.api.core.v1.ContainerStatus.containerID: - -containerID - (`string `_) Container's ID in the format 'docker://'. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.DaemonEndpoint: - -k8s.io.api.core.v1.DaemonEndpoint ---------------------------------- - -`[k8s.io.api.core.v1.DaemonEndpoint proto] `_ - -DaemonEndpoint contains information about a single Daemon endpoint. - -.. code-block:: json - - { - "Port": "..." - } - -.. _api_field_k8s.io.api.core.v1.DaemonEndpoint.Port: - -Port - (`int32 `_) Port number of the given endpoint. - - - - -.. _api_msg_k8s.io.api.core.v1.DownwardAPIProjection: - -k8s.io.api.core.v1.DownwardAPIProjection ----------------------------------------- - -`[k8s.io.api.core.v1.DownwardAPIProjection proto] `_ - -Represents downward API info for projecting into a projected volume. -Note that this is identical to a downwardAPI volume source without the default -mode. - -.. code-block:: json - - { - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.DownwardAPIProjection.items: - -items - (:ref:`k8s.io.api.core.v1.DownwardAPIVolumeFile `) Items is a list of DownwardAPIVolume file - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.DownwardAPIVolumeFile: - -k8s.io.api.core.v1.DownwardAPIVolumeFile ----------------------------------------- - -`[k8s.io.api.core.v1.DownwardAPIVolumeFile proto] `_ - -DownwardAPIVolumeFile represents information to create the file containing the pod field - -.. code-block:: json - - { - "path": "...", - "fieldRef": "{...}", - "resourceFieldRef": "{...}", - "mode": "..." - } - -.. _api_field_k8s.io.api.core.v1.DownwardAPIVolumeFile.path: - -path - (`string `_) Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..' - - -.. _api_field_k8s.io.api.core.v1.DownwardAPIVolumeFile.fieldRef: - -fieldRef - (:ref:`k8s.io.api.core.v1.ObjectFieldSelector `) Required: Selects a field of the pod: only annotations, labels, name and namespace are supported. - +optional - - -.. _api_field_k8s.io.api.core.v1.DownwardAPIVolumeFile.resourceFieldRef: - -resourceFieldRef - (:ref:`k8s.io.api.core.v1.ResourceFieldSelector `) Selects a resource of the container: only resources limits and requests - (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported. - +optional - - -.. _api_field_k8s.io.api.core.v1.DownwardAPIVolumeFile.mode: - -mode - (`int32 `_) Optional: mode bits to use on this file, must be a value between 0 - and 0777. If not specified, the volume defaultMode will be used. - This might be in conflict with other options that affect the file - mode, like fsGroup, and the result can be other mode bits set. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.DownwardAPIVolumeSource: - -k8s.io.api.core.v1.DownwardAPIVolumeSource ------------------------------------------- - -`[k8s.io.api.core.v1.DownwardAPIVolumeSource proto] `_ - -DownwardAPIVolumeSource represents a volume containing downward API info. -Downward API volumes support ownership management and SELinux relabeling. - -.. code-block:: json - - { - "items": [], - "defaultMode": "..." - } - -.. _api_field_k8s.io.api.core.v1.DownwardAPIVolumeSource.items: - -items - (:ref:`k8s.io.api.core.v1.DownwardAPIVolumeFile `) Items is a list of downward API volume file - +optional - - -.. _api_field_k8s.io.api.core.v1.DownwardAPIVolumeSource.defaultMode: - -defaultMode - (`int32 `_) Optional: mode bits to use on created files by default. Must be a - value between 0 and 0777. Defaults to 0644. - Directories within the path are not affected by this setting. - This might be in conflict with other options that affect the file - mode, like fsGroup, and the result can be other mode bits set. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.EmptyDirVolumeSource: - -k8s.io.api.core.v1.EmptyDirVolumeSource ---------------------------------------- - -`[k8s.io.api.core.v1.EmptyDirVolumeSource proto] `_ - -Represents an empty directory for a pod. -Empty directory volumes support ownership management and SELinux relabeling. - -.. code-block:: json - - { - "medium": "...", - "sizeLimit": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.EmptyDirVolumeSource.medium: - -medium - (`string `_) What type of storage medium should back this directory. - The default is "" which means to use the node's default medium. - Must be an empty string (default) or Memory. - More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir - +optional - - -.. _api_field_k8s.io.api.core.v1.EmptyDirVolumeSource.sizeLimit: - -sizeLimit - (:ref:`k8s.io.apimachinery.pkg.api.resource.Quantity `) Total amount of local storage required for this EmptyDir volume. - The size limit is also applicable for memory medium. - The maximum usage on memory medium EmptyDir would be the minimum value between - the SizeLimit specified here and the sum of memory limits of all containers in a pod. - The default is nil which means that the limit is undefined. - More info: http://kubernetes.io/docs/user-guide/volumes#emptydir - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.EndpointAddress: - -k8s.io.api.core.v1.EndpointAddress ----------------------------------- - -`[k8s.io.api.core.v1.EndpointAddress proto] `_ - -EndpointAddress is a tuple that describes single IP address. - -.. code-block:: json - - { - "ip": "...", - "hostname": "...", - "nodeName": "...", - "targetRef": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.EndpointAddress.ip: - -ip - (`string `_) The IP of this endpoint. - May not be loopback (127.0.0.0/8), link-local (169.254.0.0/16), - or link-local multicast ((224.0.0.0/24). - IPv6 is also accepted but not fully supported on all platforms. Also, certain - kubernetes components, like kube-proxy, are not IPv6 ready. - TODO: This should allow hostname or IP, See #4447. - - -.. _api_field_k8s.io.api.core.v1.EndpointAddress.hostname: - -hostname - (`string `_) The Hostname of this endpoint - +optional - - -.. _api_field_k8s.io.api.core.v1.EndpointAddress.nodeName: - -nodeName - (`string `_) Optional: Node hosting this endpoint. This can be used to determine endpoints local to a node. - +optional - - -.. _api_field_k8s.io.api.core.v1.EndpointAddress.targetRef: - -targetRef - (:ref:`k8s.io.api.core.v1.ObjectReference `) Reference to object providing the endpoint. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.EndpointPort: - -k8s.io.api.core.v1.EndpointPort -------------------------------- - -`[k8s.io.api.core.v1.EndpointPort proto] `_ - -EndpointPort is a tuple that describes a single port. - -.. code-block:: json - - { - "name": "...", - "port": "...", - "protocol": "..." - } - -.. _api_field_k8s.io.api.core.v1.EndpointPort.name: - -name - (`string `_) The name of this port (corresponds to ServicePort.Name). - Must be a DNS_LABEL. - Optional only if one port is defined. - +optional - - -.. _api_field_k8s.io.api.core.v1.EndpointPort.port: - -port - (`int32 `_) The port number of the endpoint. - - -.. _api_field_k8s.io.api.core.v1.EndpointPort.protocol: - -protocol - (`string `_) The IP protocol for this port. - Must be UDP, TCP, or SCTP. - Default is TCP. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.EndpointSubset: - -k8s.io.api.core.v1.EndpointSubset ---------------------------------- - -`[k8s.io.api.core.v1.EndpointSubset proto] `_ - -EndpointSubset is a group of addresses with a common set of ports. The -expanded set of endpoints is the Cartesian product of Addresses x Ports. -For example, given: - { - Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], - Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] - } -The resulting set of endpoints can be viewed as: - a: [ 10.10.1.1:8675, 10.10.2.2:8675 ], - b: [ 10.10.1.1:309, 10.10.2.2:309 ] - -.. code-block:: json - - { - "addresses": [], - "notReadyAddresses": [], - "ports": [] - } - -.. _api_field_k8s.io.api.core.v1.EndpointSubset.addresses: - -addresses - (:ref:`k8s.io.api.core.v1.EndpointAddress `) IP addresses which offer the related ports that are marked as ready. These endpoints - should be considered safe for load balancers and clients to utilize. - +optional - - -.. _api_field_k8s.io.api.core.v1.EndpointSubset.notReadyAddresses: - -notReadyAddresses - (:ref:`k8s.io.api.core.v1.EndpointAddress `) IP addresses which offer the related ports but are not currently marked as ready - because they have not yet finished starting, have recently failed a readiness check, - or have recently failed a liveness check. - +optional - - -.. _api_field_k8s.io.api.core.v1.EndpointSubset.ports: - -ports - (:ref:`k8s.io.api.core.v1.EndpointPort `) Port numbers available on the related IP addresses. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.Endpoints: - -k8s.io.api.core.v1.Endpoints ----------------------------- - -`[k8s.io.api.core.v1.Endpoints proto] `_ - -Endpoints is a collection of endpoints that implement the actual service. Example: - Name: "mysvc", - Subsets: [ - { - Addresses: [{"ip": "10.10.1.1"}, {"ip": "10.10.2.2"}], - Ports: [{"name": "a", "port": 8675}, {"name": "b", "port": 309}] - }, - { - Addresses: [{"ip": "10.10.3.3"}], - Ports: [{"name": "a", "port": 93}, {"name": "b", "port": 76}] - }, - ] - -.. code-block:: json - - { - "metadata": "{...}", - "subsets": [] - } - -.. _api_field_k8s.io.api.core.v1.Endpoints.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.Endpoints.subsets: - -subsets - (:ref:`k8s.io.api.core.v1.EndpointSubset `) The set of all endpoints is the union of all subsets. Addresses are placed into - subsets according to the IPs they share. A single address with multiple ports, - some of which are ready and some of which are not (because they come from - different containers) will result in the address being displayed in different - subsets for the different ports. No address will appear in both Addresses and - NotReadyAddresses in the same subset. - Sets of addresses and ports that comprise a service. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.EndpointsList: - -k8s.io.api.core.v1.EndpointsList --------------------------------- - -`[k8s.io.api.core.v1.EndpointsList proto] `_ - -EndpointsList is a list of endpoints. - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.EndpointsList.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.api.core.v1.EndpointsList.items: - -items - (:ref:`k8s.io.api.core.v1.Endpoints `) List of endpoints. - - - - -.. _api_msg_k8s.io.api.core.v1.EnvFromSource: - -k8s.io.api.core.v1.EnvFromSource --------------------------------- - -`[k8s.io.api.core.v1.EnvFromSource proto] `_ - -EnvFromSource represents the source of a set of ConfigMaps - -.. code-block:: json - - { - "prefix": "...", - "configMapRef": "{...}", - "secretRef": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.EnvFromSource.prefix: - -prefix - (`string `_) An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. - +optional - - -.. _api_field_k8s.io.api.core.v1.EnvFromSource.configMapRef: - -configMapRef - (:ref:`k8s.io.api.core.v1.ConfigMapEnvSource `) The ConfigMap to select from - +optional - - -.. _api_field_k8s.io.api.core.v1.EnvFromSource.secretRef: - -secretRef - (:ref:`k8s.io.api.core.v1.SecretEnvSource `) The Secret to select from - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.EnvVar: - -k8s.io.api.core.v1.EnvVar -------------------------- - -`[k8s.io.api.core.v1.EnvVar proto] `_ - -EnvVar represents an environment variable present in a Container. - -.. code-block:: json - - { - "name": "...", - "value": "...", - "valueFrom": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.EnvVar.name: - -name - (`string `_) Name of the environment variable. Must be a C_IDENTIFIER. - - -.. _api_field_k8s.io.api.core.v1.EnvVar.value: - -value - (`string `_) Variable references $(VAR_NAME) are expanded - using the previous defined environment variables in the container and - any service environment variables. If a variable cannot be resolved, - the reference in the input string will be unchanged. The $(VAR_NAME) - syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped - references will never be expanded, regardless of whether the variable - exists or not. - Defaults to "". - +optional - - -.. _api_field_k8s.io.api.core.v1.EnvVar.valueFrom: - -valueFrom - (:ref:`k8s.io.api.core.v1.EnvVarSource `) Source for the environment variable's value. Cannot be used if value is not empty. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.EnvVarSource: - -k8s.io.api.core.v1.EnvVarSource -------------------------------- - -`[k8s.io.api.core.v1.EnvVarSource proto] `_ - -EnvVarSource represents a source for the value of an EnvVar. - -.. code-block:: json - - { - "fieldRef": "{...}", - "resourceFieldRef": "{...}", - "configMapKeyRef": "{...}", - "secretKeyRef": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.EnvVarSource.fieldRef: - -fieldRef - (:ref:`k8s.io.api.core.v1.ObjectFieldSelector `) Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels, metadata.annotations, - spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP. - +optional - - -.. _api_field_k8s.io.api.core.v1.EnvVarSource.resourceFieldRef: - -resourceFieldRef - (:ref:`k8s.io.api.core.v1.ResourceFieldSelector `) Selects a resource of the container: only resources limits and requests - (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported. - +optional - - -.. _api_field_k8s.io.api.core.v1.EnvVarSource.configMapKeyRef: - -configMapKeyRef - (:ref:`k8s.io.api.core.v1.ConfigMapKeySelector `) Selects a key of a ConfigMap. - +optional - - -.. _api_field_k8s.io.api.core.v1.EnvVarSource.secretKeyRef: - -secretKeyRef - (:ref:`k8s.io.api.core.v1.SecretKeySelector `) Selects a key of a secret in the pod's namespace - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.Event: - -k8s.io.api.core.v1.Event ------------------------- - -`[k8s.io.api.core.v1.Event proto] `_ - -Event is a report of an event somewhere in the cluster. - -.. code-block:: json - - { - "metadata": "{...}", - "involvedObject": "{...}", - "reason": "...", - "message": "...", - "source": "{...}", - "firstTimestamp": "{...}", - "lastTimestamp": "{...}", - "count": "...", - "type": "...", - "eventTime": "{...}", - "series": "{...}", - "action": "...", - "related": "{...}", - "reportingComponent": "...", - "reportingInstance": "..." - } - -.. _api_field_k8s.io.api.core.v1.Event.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - - -.. _api_field_k8s.io.api.core.v1.Event.involvedObject: - -involvedObject - (:ref:`k8s.io.api.core.v1.ObjectReference `) The object that this event is about. - - -.. _api_field_k8s.io.api.core.v1.Event.reason: - -reason - (`string `_) This should be a short, machine understandable string that gives the reason - for the transition into the object's current status. - TODO: provide exact specification for format. - +optional - - -.. _api_field_k8s.io.api.core.v1.Event.message: - -message - (`string `_) A human-readable description of the status of this operation. - TODO: decide on maximum length. - +optional - - -.. _api_field_k8s.io.api.core.v1.Event.source: - -source - (:ref:`k8s.io.api.core.v1.EventSource `) The component reporting this event. Should be a short machine understandable string. - +optional - - -.. _api_field_k8s.io.api.core.v1.Event.firstTimestamp: - -firstTimestamp - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) The time at which the event was first recorded. (Time of server receipt is in TypeMeta.) - +optional - - -.. _api_field_k8s.io.api.core.v1.Event.lastTimestamp: - -lastTimestamp - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) The time at which the most recent occurrence of this event was recorded. - +optional - - -.. _api_field_k8s.io.api.core.v1.Event.count: - -count - (`int32 `_) The number of times this event has occurred. - +optional - - -.. _api_field_k8s.io.api.core.v1.Event.type: - -type - (`string `_) Type of this event (Normal, Warning), new types could be added in the future - +optional - - -.. _api_field_k8s.io.api.core.v1.Event.eventTime: - -eventTime - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.MicroTime `) Time when this Event was first observed. - +optional - - -.. _api_field_k8s.io.api.core.v1.Event.series: - -series - (:ref:`k8s.io.api.core.v1.EventSeries `) Data about the Event series this event represents or nil if it's a singleton Event. - +optional - - -.. _api_field_k8s.io.api.core.v1.Event.action: - -action - (`string `_) What action was taken/failed regarding to the Regarding object. - +optional - - -.. _api_field_k8s.io.api.core.v1.Event.related: - -related - (:ref:`k8s.io.api.core.v1.ObjectReference `) Optional secondary object for more complex actions. - +optional - - -.. _api_field_k8s.io.api.core.v1.Event.reportingComponent: - -reportingComponent - (`string `_) Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`. - +optional - - -.. _api_field_k8s.io.api.core.v1.Event.reportingInstance: - -reportingInstance - (`string `_) ID of the controller instance, e.g. `kubelet-xyzf`. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.EventList: - -k8s.io.api.core.v1.EventList ----------------------------- - -`[k8s.io.api.core.v1.EventList proto] `_ - -EventList is a list of events. - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.EventList.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.api.core.v1.EventList.items: - -items - (:ref:`k8s.io.api.core.v1.Event `) List of events - - - - -.. _api_msg_k8s.io.api.core.v1.EventSeries: - -k8s.io.api.core.v1.EventSeries ------------------------------- - -`[k8s.io.api.core.v1.EventSeries proto] `_ - -EventSeries contain information on series of events, i.e. thing that was/is happening -continuously for some time. - -.. code-block:: json - - { - "count": "...", - "lastObservedTime": "{...}", - "state": "..." - } - -.. _api_field_k8s.io.api.core.v1.EventSeries.count: - -count - (`int32 `_) Number of occurrences in this series up to the last heartbeat time - - -.. _api_field_k8s.io.api.core.v1.EventSeries.lastObservedTime: - -lastObservedTime - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.MicroTime `) Time of the last occurrence observed - - -.. _api_field_k8s.io.api.core.v1.EventSeries.state: - -state - (`string `_) State of this Series: Ongoing or Finished - - - - -.. _api_msg_k8s.io.api.core.v1.EventSource: - -k8s.io.api.core.v1.EventSource ------------------------------- - -`[k8s.io.api.core.v1.EventSource proto] `_ - -EventSource contains information for an event. - -.. code-block:: json - - { - "component": "...", - "host": "..." - } - -.. _api_field_k8s.io.api.core.v1.EventSource.component: - -component - (`string `_) Component from which the event is generated. - +optional - - -.. _api_field_k8s.io.api.core.v1.EventSource.host: - -host - (`string `_) Node name on which the event is generated. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ExecAction: - -k8s.io.api.core.v1.ExecAction ------------------------------ - -`[k8s.io.api.core.v1.ExecAction proto] `_ - -ExecAction describes a "run in container" action. - -.. code-block:: json - - { - "command": [] - } - -.. _api_field_k8s.io.api.core.v1.ExecAction.command: - -command - (`string `_) Command is the command line to execute inside the container, the working directory for the - command is root ('/') in the container's filesystem. The command is simply exec'd, it is - not run inside a shell, so traditional shell instructions ('|', etc) won't work. To use - a shell, you need to explicitly call out to that shell. - Exit status of 0 is treated as live/healthy and non-zero is unhealthy. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.FCVolumeSource: - -k8s.io.api.core.v1.FCVolumeSource ---------------------------------- - -`[k8s.io.api.core.v1.FCVolumeSource proto] `_ - -Represents a Fibre Channel volume. -Fibre Channel volumes can only be mounted as read/write once. -Fibre Channel volumes support ownership management and SELinux relabeling. - -.. code-block:: json - - { - "targetWWNs": [], - "lun": "...", - "fsType": "...", - "readOnly": "...", - "wwids": [] - } - -.. _api_field_k8s.io.api.core.v1.FCVolumeSource.targetWWNs: - -targetWWNs - (`string `_) Optional: FC target worldwide names (WWNs) - +optional - - -.. _api_field_k8s.io.api.core.v1.FCVolumeSource.lun: - -lun - (`int32 `_) Optional: FC target lun number - +optional - - -.. _api_field_k8s.io.api.core.v1.FCVolumeSource.fsType: - -fsType - (`string `_) Filesystem type to mount. - Must be a filesystem type supported by the host operating system. - Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - TODO: how do we prevent errors in the filesystem from compromising the machine - +optional - - -.. _api_field_k8s.io.api.core.v1.FCVolumeSource.readOnly: - -readOnly - (`bool `_) Optional: Defaults to false (read/write). ReadOnly here will force - the ReadOnly setting in VolumeMounts. - +optional - - -.. _api_field_k8s.io.api.core.v1.FCVolumeSource.wwids: - -wwids - (`string `_) Optional: FC volume world wide identifiers (wwids) - Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.FlexPersistentVolumeSource: - -k8s.io.api.core.v1.FlexPersistentVolumeSource ---------------------------------------------- - -`[k8s.io.api.core.v1.FlexPersistentVolumeSource proto] `_ - -FlexPersistentVolumeSource represents a generic persistent volume resource that is -provisioned/attached using an exec based plugin. - -.. code-block:: json - - { - "driver": "...", - "fsType": "...", - "secretRef": "{...}", - "readOnly": "...", - "options": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.FlexPersistentVolumeSource.driver: - -driver - (`string `_) Driver is the name of the driver to use for this volume. - - -.. _api_field_k8s.io.api.core.v1.FlexPersistentVolumeSource.fsType: - -fsType - (`string `_) Filesystem type to mount. - Must be a filesystem type supported by the host operating system. - Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. - +optional - - -.. _api_field_k8s.io.api.core.v1.FlexPersistentVolumeSource.secretRef: - -secretRef - (:ref:`k8s.io.api.core.v1.SecretReference `) Optional: SecretRef is reference to the secret object containing - sensitive information to pass to the plugin scripts. This may be - empty if no secret object is specified. If the secret object - contains more than one secret, all secrets are passed to the plugin - scripts. - +optional - - -.. _api_field_k8s.io.api.core.v1.FlexPersistentVolumeSource.readOnly: - -readOnly - (`bool `_) Optional: Defaults to false (read/write). ReadOnly here will force - the ReadOnly setting in VolumeMounts. - +optional - - -.. _api_field_k8s.io.api.core.v1.FlexPersistentVolumeSource.options: - -options - (map<`string `_, `string `_>) Optional: Extra command options if any. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.FlexVolumeSource: - -k8s.io.api.core.v1.FlexVolumeSource ------------------------------------ - -`[k8s.io.api.core.v1.FlexVolumeSource proto] `_ - -FlexVolume represents a generic volume resource that is -provisioned/attached using an exec based plugin. - -.. code-block:: json - - { - "driver": "...", - "fsType": "...", - "secretRef": "{...}", - "readOnly": "...", - "options": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.FlexVolumeSource.driver: - -driver - (`string `_) Driver is the name of the driver to use for this volume. - - -.. _api_field_k8s.io.api.core.v1.FlexVolumeSource.fsType: - -fsType - (`string `_) Filesystem type to mount. - Must be a filesystem type supported by the host operating system. - Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script. - +optional - - -.. _api_field_k8s.io.api.core.v1.FlexVolumeSource.secretRef: - -secretRef - (:ref:`k8s.io.api.core.v1.LocalObjectReference `) Optional: SecretRef is reference to the secret object containing - sensitive information to pass to the plugin scripts. This may be - empty if no secret object is specified. If the secret object - contains more than one secret, all secrets are passed to the plugin - scripts. - +optional - - -.. _api_field_k8s.io.api.core.v1.FlexVolumeSource.readOnly: - -readOnly - (`bool `_) Optional: Defaults to false (read/write). ReadOnly here will force - the ReadOnly setting in VolumeMounts. - +optional - - -.. _api_field_k8s.io.api.core.v1.FlexVolumeSource.options: - -options - (map<`string `_, `string `_>) Optional: Extra command options if any. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.FlockerVolumeSource: - -k8s.io.api.core.v1.FlockerVolumeSource --------------------------------------- - -`[k8s.io.api.core.v1.FlockerVolumeSource proto] `_ - -Represents a Flocker volume mounted by the Flocker agent. -One and only one of datasetName and datasetUUID should be set. -Flocker volumes do not support ownership management or SELinux relabeling. - -.. code-block:: json - - { - "datasetName": "...", - "datasetUUID": "..." - } - -.. _api_field_k8s.io.api.core.v1.FlockerVolumeSource.datasetName: - -datasetName - (`string `_) Name of the dataset stored as metadata -> name on the dataset for Flocker - should be considered as deprecated - +optional - - -.. _api_field_k8s.io.api.core.v1.FlockerVolumeSource.datasetUUID: - -datasetUUID - (`string `_) UUID of the dataset. This is unique identifier of a Flocker dataset - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.GCEPersistentDiskVolumeSource: - -k8s.io.api.core.v1.GCEPersistentDiskVolumeSource ------------------------------------------------- - -`[k8s.io.api.core.v1.GCEPersistentDiskVolumeSource proto] `_ - -Represents a Persistent Disk resource in Google Compute Engine. - -A GCE PD must exist before mounting to a container. The disk must -also be in the same GCE project and zone as the kubelet. A GCE PD -can only be mounted as read/write once or read-only many times. GCE -PDs support ownership management and SELinux relabeling. - -.. code-block:: json - - { - "pdName": "...", - "fsType": "...", - "partition": "...", - "readOnly": "..." - } - -.. _api_field_k8s.io.api.core.v1.GCEPersistentDiskVolumeSource.pdName: - -pdName - (`string `_) Unique name of the PD resource in GCE. Used to identify the disk in GCE. - More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk - - -.. _api_field_k8s.io.api.core.v1.GCEPersistentDiskVolumeSource.fsType: - -fsType - (`string `_) Filesystem type of the volume that you want to mount. - Tip: Ensure that the filesystem type is supported by the host operating system. - Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk - TODO: how do we prevent errors in the filesystem from compromising the machine - +optional - - -.. _api_field_k8s.io.api.core.v1.GCEPersistentDiskVolumeSource.partition: - -partition - (`int32 `_) The partition in the volume that you want to mount. - If omitted, the default is to mount by volume name. - Examples: For volume /dev/sda1, you specify the partition as "1". - Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). - More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk - +optional - - -.. _api_field_k8s.io.api.core.v1.GCEPersistentDiskVolumeSource.readOnly: - -readOnly - (`bool `_) ReadOnly here will force the ReadOnly setting in VolumeMounts. - Defaults to false. - More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.GitRepoVolumeSource: - -k8s.io.api.core.v1.GitRepoVolumeSource --------------------------------------- - -`[k8s.io.api.core.v1.GitRepoVolumeSource proto] `_ - -Represents a volume that is populated with the contents of a git repository. -Git repo volumes do not support ownership management. -Git repo volumes support SELinux relabeling. - -DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an -EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir -into the Pod's container. - -.. code-block:: json - - { - "repository": "...", - "revision": "...", - "directory": "..." - } - -.. _api_field_k8s.io.api.core.v1.GitRepoVolumeSource.repository: - -repository - (`string `_) Repository URL - - -.. _api_field_k8s.io.api.core.v1.GitRepoVolumeSource.revision: - -revision - (`string `_) Commit hash for the specified revision. - +optional - - -.. _api_field_k8s.io.api.core.v1.GitRepoVolumeSource.directory: - -directory - (`string `_) Target directory name. - Must not contain or start with '..'. If '.' is supplied, the volume directory will be the - git repository. Otherwise, if specified, the volume will contain the git repository in - the subdirectory with the given name. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.GlusterfsPersistentVolumeSource: - -k8s.io.api.core.v1.GlusterfsPersistentVolumeSource --------------------------------------------------- - -`[k8s.io.api.core.v1.GlusterfsPersistentVolumeSource proto] `_ - -Represents a Glusterfs mount that lasts the lifetime of a pod. -Glusterfs volumes do not support ownership management or SELinux relabeling. - -.. code-block:: json - - { - "endpoints": "...", - "path": "...", - "readOnly": "...", - "endpointsNamespace": "..." - } - -.. _api_field_k8s.io.api.core.v1.GlusterfsPersistentVolumeSource.endpoints: - -endpoints - (`string `_) EndpointsName is the endpoint name that details Glusterfs topology. - More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod - - -.. _api_field_k8s.io.api.core.v1.GlusterfsPersistentVolumeSource.path: - -path - (`string `_) Path is the Glusterfs volume path. - More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod - - -.. _api_field_k8s.io.api.core.v1.GlusterfsPersistentVolumeSource.readOnly: - -readOnly - (`bool `_) ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. - Defaults to false. - More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod - +optional - - -.. _api_field_k8s.io.api.core.v1.GlusterfsPersistentVolumeSource.endpointsNamespace: - -endpointsNamespace - (`string `_) EndpointsNamespace is the namespace that contains Glusterfs endpoint. - If this field is empty, the EndpointNamespace defaults to the same namespace as the bound PVC. - More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.GlusterfsVolumeSource: - -k8s.io.api.core.v1.GlusterfsVolumeSource ----------------------------------------- - -`[k8s.io.api.core.v1.GlusterfsVolumeSource proto] `_ - -Represents a Glusterfs mount that lasts the lifetime of a pod. -Glusterfs volumes do not support ownership management or SELinux relabeling. - -.. code-block:: json - - { - "endpoints": "...", - "path": "...", - "readOnly": "..." - } - -.. _api_field_k8s.io.api.core.v1.GlusterfsVolumeSource.endpoints: - -endpoints - (`string `_) EndpointsName is the endpoint name that details Glusterfs topology. - More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod - - -.. _api_field_k8s.io.api.core.v1.GlusterfsVolumeSource.path: - -path - (`string `_) Path is the Glusterfs volume path. - More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod - - -.. _api_field_k8s.io.api.core.v1.GlusterfsVolumeSource.readOnly: - -readOnly - (`bool `_) ReadOnly here will force the Glusterfs volume to be mounted with read-only permissions. - Defaults to false. - More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md#create-a-pod - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.HTTPGetAction: - -k8s.io.api.core.v1.HTTPGetAction --------------------------------- - -`[k8s.io.api.core.v1.HTTPGetAction proto] `_ - -HTTPGetAction describes an action based on HTTP Get requests. - -.. code-block:: json - - { - "path": "...", - "port": "{...}", - "host": "...", - "scheme": "...", - "httpHeaders": [] - } - -.. _api_field_k8s.io.api.core.v1.HTTPGetAction.path: - -path - (`string `_) Path to access on the HTTP server. - +optional - - -.. _api_field_k8s.io.api.core.v1.HTTPGetAction.port: - -port - (:ref:`k8s.io.apimachinery.pkg.util.intstr.IntOrString `) Name or number of the port to access on the container. - Number must be in the range 1 to 65535. - Name must be an IANA_SVC_NAME. - - -.. _api_field_k8s.io.api.core.v1.HTTPGetAction.host: - -host - (`string `_) Host name to connect to, defaults to the pod IP. You probably want to set - "Host" in httpHeaders instead. - +optional - - -.. _api_field_k8s.io.api.core.v1.HTTPGetAction.scheme: - -scheme - (`string `_) Scheme to use for connecting to the host. - Defaults to HTTP. - +optional - - -.. _api_field_k8s.io.api.core.v1.HTTPGetAction.httpHeaders: - -httpHeaders - (:ref:`k8s.io.api.core.v1.HTTPHeader `) Custom headers to set in the request. HTTP allows repeated headers. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.HTTPHeader: - -k8s.io.api.core.v1.HTTPHeader ------------------------------ - -`[k8s.io.api.core.v1.HTTPHeader proto] `_ - -HTTPHeader describes a custom header to be used in HTTP probes - -.. code-block:: json - - { - "name": "...", - "value": "..." - } - -.. _api_field_k8s.io.api.core.v1.HTTPHeader.name: - -name - (`string `_) The header field name - - -.. _api_field_k8s.io.api.core.v1.HTTPHeader.value: - -value - (`string `_) The header field value - - - - -.. _api_msg_k8s.io.api.core.v1.Handler: - -k8s.io.api.core.v1.Handler --------------------------- - -`[k8s.io.api.core.v1.Handler proto] `_ - -Handler defines a specific action that should be taken -TODO: pass structured data to these actions, and document that data here. - -.. code-block:: json - - { - "exec": "{...}", - "httpGet": "{...}", - "tcpSocket": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.Handler.exec: - -exec - (:ref:`k8s.io.api.core.v1.ExecAction `) One and only one of the following should be specified. - Exec specifies the action to take. - +optional - - -.. _api_field_k8s.io.api.core.v1.Handler.httpGet: - -httpGet - (:ref:`k8s.io.api.core.v1.HTTPGetAction `) HTTPGet specifies the http request to perform. - +optional - - -.. _api_field_k8s.io.api.core.v1.Handler.tcpSocket: - -tcpSocket - (:ref:`k8s.io.api.core.v1.TCPSocketAction `) TCPSocket specifies an action involving a TCP port. - TCP hooks not yet supported - TODO: implement a realistic TCP lifecycle hook - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.HostAlias: - -k8s.io.api.core.v1.HostAlias ----------------------------- - -`[k8s.io.api.core.v1.HostAlias proto] `_ - -HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the -pod's hosts file. - -.. code-block:: json - - { - "ip": "...", - "hostnames": [] - } - -.. _api_field_k8s.io.api.core.v1.HostAlias.ip: - -ip - (`string `_) IP address of the host file entry. - - -.. _api_field_k8s.io.api.core.v1.HostAlias.hostnames: - -hostnames - (`string `_) Hostnames for the above IP address. - - - - -.. _api_msg_k8s.io.api.core.v1.HostPathVolumeSource: - -k8s.io.api.core.v1.HostPathVolumeSource ---------------------------------------- - -`[k8s.io.api.core.v1.HostPathVolumeSource proto] `_ - -Represents a host path mapped into a pod. -Host path volumes do not support ownership management or SELinux relabeling. - -.. code-block:: json - - { - "path": "...", - "type": "..." - } - -.. _api_field_k8s.io.api.core.v1.HostPathVolumeSource.path: - -path - (`string `_) Path of the directory on the host. - If the path is a symlink, it will follow the link to the real path. - More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath - - -.. _api_field_k8s.io.api.core.v1.HostPathVolumeSource.type: - -type - (`string `_) Type for HostPath Volume - Defaults to "" - More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ISCSIPersistentVolumeSource: - -k8s.io.api.core.v1.ISCSIPersistentVolumeSource ----------------------------------------------- - -`[k8s.io.api.core.v1.ISCSIPersistentVolumeSource proto] `_ - -ISCSIPersistentVolumeSource represents an ISCSI disk. -ISCSI volumes can only be mounted as read/write once. -ISCSI volumes support ownership management and SELinux relabeling. - -.. code-block:: json - - { - "targetPortal": "...", - "iqn": "...", - "lun": "...", - "iscsiInterface": "...", - "fsType": "...", - "readOnly": "...", - "portals": [], - "chapAuthDiscovery": "...", - "chapAuthSession": "...", - "secretRef": "{...}", - "initiatorName": "..." - } - -.. _api_field_k8s.io.api.core.v1.ISCSIPersistentVolumeSource.targetPortal: - -targetPortal - (`string `_) iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port - is other than default (typically TCP ports 860 and 3260). - - -.. _api_field_k8s.io.api.core.v1.ISCSIPersistentVolumeSource.iqn: - -iqn - (`string `_) Target iSCSI Qualified Name. - - -.. _api_field_k8s.io.api.core.v1.ISCSIPersistentVolumeSource.lun: - -lun - (`int32 `_) iSCSI Target Lun number. - - -.. _api_field_k8s.io.api.core.v1.ISCSIPersistentVolumeSource.iscsiInterface: - -iscsiInterface - (`string `_) iSCSI Interface Name that uses an iSCSI transport. - Defaults to 'default' (tcp). - +optional - - -.. _api_field_k8s.io.api.core.v1.ISCSIPersistentVolumeSource.fsType: - -fsType - (`string `_) Filesystem type of the volume that you want to mount. - Tip: Ensure that the filesystem type is supported by the host operating system. - Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi - TODO: how do we prevent errors in the filesystem from compromising the machine - +optional - - -.. _api_field_k8s.io.api.core.v1.ISCSIPersistentVolumeSource.readOnly: - -readOnly - (`bool `_) ReadOnly here will force the ReadOnly setting in VolumeMounts. - Defaults to false. - +optional - - -.. _api_field_k8s.io.api.core.v1.ISCSIPersistentVolumeSource.portals: - -portals - (`string `_) iSCSI Target Portal List. The Portal is either an IP or ip_addr:port if the port - is other than default (typically TCP ports 860 and 3260). - +optional - - -.. _api_field_k8s.io.api.core.v1.ISCSIPersistentVolumeSource.chapAuthDiscovery: - -chapAuthDiscovery - (`bool `_) whether support iSCSI Discovery CHAP authentication - +optional - - -.. _api_field_k8s.io.api.core.v1.ISCSIPersistentVolumeSource.chapAuthSession: - -chapAuthSession - (`bool `_) whether support iSCSI Session CHAP authentication - +optional - - -.. _api_field_k8s.io.api.core.v1.ISCSIPersistentVolumeSource.secretRef: - -secretRef - (:ref:`k8s.io.api.core.v1.SecretReference `) CHAP Secret for iSCSI target and initiator authentication - +optional - - -.. _api_field_k8s.io.api.core.v1.ISCSIPersistentVolumeSource.initiatorName: - -initiatorName - (`string `_) Custom iSCSI Initiator Name. - If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface - : will be created for the connection. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ISCSIVolumeSource: - -k8s.io.api.core.v1.ISCSIVolumeSource ------------------------------------- - -`[k8s.io.api.core.v1.ISCSIVolumeSource proto] `_ - -Represents an ISCSI disk. -ISCSI volumes can only be mounted as read/write once. -ISCSI volumes support ownership management and SELinux relabeling. - -.. code-block:: json - - { - "targetPortal": "...", - "iqn": "...", - "lun": "...", - "iscsiInterface": "...", - "fsType": "...", - "readOnly": "...", - "portals": [], - "chapAuthDiscovery": "...", - "chapAuthSession": "...", - "secretRef": "{...}", - "initiatorName": "..." - } - -.. _api_field_k8s.io.api.core.v1.ISCSIVolumeSource.targetPortal: - -targetPortal - (`string `_) iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port - is other than default (typically TCP ports 860 and 3260). - - -.. _api_field_k8s.io.api.core.v1.ISCSIVolumeSource.iqn: - -iqn - (`string `_) Target iSCSI Qualified Name. - - -.. _api_field_k8s.io.api.core.v1.ISCSIVolumeSource.lun: - -lun - (`int32 `_) iSCSI Target Lun number. - - -.. _api_field_k8s.io.api.core.v1.ISCSIVolumeSource.iscsiInterface: - -iscsiInterface - (`string `_) iSCSI Interface Name that uses an iSCSI transport. - Defaults to 'default' (tcp). - +optional - - -.. _api_field_k8s.io.api.core.v1.ISCSIVolumeSource.fsType: - -fsType - (`string `_) Filesystem type of the volume that you want to mount. - Tip: Ensure that the filesystem type is supported by the host operating system. - Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi - TODO: how do we prevent errors in the filesystem from compromising the machine - +optional - - -.. _api_field_k8s.io.api.core.v1.ISCSIVolumeSource.readOnly: - -readOnly - (`bool `_) ReadOnly here will force the ReadOnly setting in VolumeMounts. - Defaults to false. - +optional - - -.. _api_field_k8s.io.api.core.v1.ISCSIVolumeSource.portals: - -portals - (`string `_) iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port - is other than default (typically TCP ports 860 and 3260). - +optional - - -.. _api_field_k8s.io.api.core.v1.ISCSIVolumeSource.chapAuthDiscovery: - -chapAuthDiscovery - (`bool `_) whether support iSCSI Discovery CHAP authentication - +optional - - -.. _api_field_k8s.io.api.core.v1.ISCSIVolumeSource.chapAuthSession: - -chapAuthSession - (`bool `_) whether support iSCSI Session CHAP authentication - +optional - - -.. _api_field_k8s.io.api.core.v1.ISCSIVolumeSource.secretRef: - -secretRef - (:ref:`k8s.io.api.core.v1.LocalObjectReference `) CHAP Secret for iSCSI target and initiator authentication - +optional - - -.. _api_field_k8s.io.api.core.v1.ISCSIVolumeSource.initiatorName: - -initiatorName - (`string `_) Custom iSCSI Initiator Name. - If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface - : will be created for the connection. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.KeyToPath: - -k8s.io.api.core.v1.KeyToPath ----------------------------- - -`[k8s.io.api.core.v1.KeyToPath proto] `_ - -Maps a string key to a path within a volume. - -.. code-block:: json - - { - "key": "...", - "path": "...", - "mode": "..." - } - -.. _api_field_k8s.io.api.core.v1.KeyToPath.key: - -key - (`string `_) The key to project. - - -.. _api_field_k8s.io.api.core.v1.KeyToPath.path: - -path - (`string `_) The relative path of the file to map the key to. - May not be an absolute path. - May not contain the path element '..'. - May not start with the string '..'. - - -.. _api_field_k8s.io.api.core.v1.KeyToPath.mode: - -mode - (`int32 `_) Optional: mode bits to use on this file, must be a value between 0 - and 0777. If not specified, the volume defaultMode will be used. - This might be in conflict with other options that affect the file - mode, like fsGroup, and the result can be other mode bits set. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.Lifecycle: - -k8s.io.api.core.v1.Lifecycle ----------------------------- - -`[k8s.io.api.core.v1.Lifecycle proto] `_ - -Lifecycle describes actions that the management system should take in response to container lifecycle -events. For the PostStart and PreStop lifecycle handlers, management of the container blocks -until the action is complete, unless the container process fails, in which case the handler is aborted. - -.. code-block:: json - - { - "postStart": "{...}", - "preStop": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.Lifecycle.postStart: - -postStart - (:ref:`k8s.io.api.core.v1.Handler `) PostStart is called immediately after a container is created. If the handler fails, - the container is terminated and restarted according to its restart policy. - Other management of the container blocks until the hook completes. - More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks - +optional - - -.. _api_field_k8s.io.api.core.v1.Lifecycle.preStop: - -preStop - (:ref:`k8s.io.api.core.v1.Handler `) PreStop is called immediately before a container is terminated due to an - API request or management event such as liveness probe failure, - preemption, resource contention, etc. The handler is not called if the - container crashes or exits. The reason for termination is passed to the - handler. The Pod's termination grace period countdown begins before the - PreStop hooked is executed. Regardless of the outcome of the handler, the - container will eventually terminate within the Pod's termination grace - period. Other management of the container blocks until the hook completes - or until the termination grace period is reached. - More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.LimitRange: - -k8s.io.api.core.v1.LimitRange ------------------------------ - -`[k8s.io.api.core.v1.LimitRange proto] `_ - -LimitRange sets resource usage limits for each kind of resource in a Namespace. - -.. code-block:: json - - { - "metadata": "{...}", - "spec": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.LimitRange.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.LimitRange.spec: - -spec - (:ref:`k8s.io.api.core.v1.LimitRangeSpec `) Spec defines the limits enforced. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.LimitRangeItem: - -k8s.io.api.core.v1.LimitRangeItem ---------------------------------- - -`[k8s.io.api.core.v1.LimitRangeItem proto] `_ - -LimitRangeItem defines a min/max usage limit for any resource that matches on kind. - -.. code-block:: json - - { - "type": "...", - "max": "{...}", - "min": "{...}", - "default": "{...}", - "defaultRequest": "{...}", - "maxLimitRequestRatio": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.LimitRangeItem.type: - -type - (`string `_) Type of resource that this limit applies to. - +optional - - -.. _api_field_k8s.io.api.core.v1.LimitRangeItem.max: - -max - (map<`string `_, :ref:`k8s.io.apimachinery.pkg.api.resource.Quantity `>) Max usage constraints on this kind by resource name. - +optional - - -.. _api_field_k8s.io.api.core.v1.LimitRangeItem.min: - -min - (map<`string `_, :ref:`k8s.io.apimachinery.pkg.api.resource.Quantity `>) Min usage constraints on this kind by resource name. - +optional - - -.. _api_field_k8s.io.api.core.v1.LimitRangeItem.default: - -default - (map<`string `_, :ref:`k8s.io.apimachinery.pkg.api.resource.Quantity `>) Default resource requirement limit value by resource name if resource limit is omitted. - +optional - - -.. _api_field_k8s.io.api.core.v1.LimitRangeItem.defaultRequest: - -defaultRequest - (map<`string `_, :ref:`k8s.io.apimachinery.pkg.api.resource.Quantity `>) DefaultRequest is the default resource requirement request value by resource name if resource request is omitted. - +optional - - -.. _api_field_k8s.io.api.core.v1.LimitRangeItem.maxLimitRequestRatio: - -maxLimitRequestRatio - (map<`string `_, :ref:`k8s.io.apimachinery.pkg.api.resource.Quantity `>) MaxLimitRequestRatio if specified, the named resource must have a request and limit that are both non-zero where limit divided by request is less than or equal to the enumerated value; this represents the max burst for the named resource. - +optional - - - - - - - - -.. _api_msg_k8s.io.api.core.v1.LimitRangeList: - -k8s.io.api.core.v1.LimitRangeList ---------------------------------- - -`[k8s.io.api.core.v1.LimitRangeList proto] `_ - -LimitRangeList is a list of LimitRange items. - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.LimitRangeList.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.api.core.v1.LimitRangeList.items: - -items - (:ref:`k8s.io.api.core.v1.LimitRange `) Items is a list of LimitRange objects. - More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ - - - - -.. _api_msg_k8s.io.api.core.v1.LimitRangeSpec: - -k8s.io.api.core.v1.LimitRangeSpec ---------------------------------- - -`[k8s.io.api.core.v1.LimitRangeSpec proto] `_ - -LimitRangeSpec defines a min/max usage limit for resources that match on kind. - -.. code-block:: json - - { - "limits": [] - } - -.. _api_field_k8s.io.api.core.v1.LimitRangeSpec.limits: - -limits - (:ref:`k8s.io.api.core.v1.LimitRangeItem `) Limits is the list of LimitRangeItem objects that are enforced. - - - - -.. _api_msg_k8s.io.api.core.v1.List: - -k8s.io.api.core.v1.List ------------------------ - -`[k8s.io.api.core.v1.List proto] `_ - -List holds a list of objects, which may not be known by the server. - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.List.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.api.core.v1.List.items: - -items - (:ref:`k8s.io.apimachinery.pkg.runtime.RawExtension `) List of objects - - - - -.. _api_msg_k8s.io.api.core.v1.LoadBalancerIngress: - -k8s.io.api.core.v1.LoadBalancerIngress --------------------------------------- - -`[k8s.io.api.core.v1.LoadBalancerIngress proto] `_ - -LoadBalancerIngress represents the status of a load-balancer ingress point: -traffic intended for the service should be sent to an ingress point. - -.. code-block:: json - - { - "ip": "...", - "hostname": "..." - } - -.. _api_field_k8s.io.api.core.v1.LoadBalancerIngress.ip: - -ip - (`string `_) IP is set for load-balancer ingress points that are IP based - (typically GCE or OpenStack load-balancers) - +optional - - -.. _api_field_k8s.io.api.core.v1.LoadBalancerIngress.hostname: - -hostname - (`string `_) Hostname is set for load-balancer ingress points that are DNS based - (typically AWS load-balancers) - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.LoadBalancerStatus: - -k8s.io.api.core.v1.LoadBalancerStatus -------------------------------------- - -`[k8s.io.api.core.v1.LoadBalancerStatus proto] `_ - -LoadBalancerStatus represents the status of a load-balancer. - -.. code-block:: json - - { - "ingress": [] - } - -.. _api_field_k8s.io.api.core.v1.LoadBalancerStatus.ingress: - -ingress - (:ref:`k8s.io.api.core.v1.LoadBalancerIngress `) Ingress is a list containing ingress points for the load-balancer. - Traffic intended for the service should be sent to these ingress points. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.LocalObjectReference: - -k8s.io.api.core.v1.LocalObjectReference ---------------------------------------- - -`[k8s.io.api.core.v1.LocalObjectReference proto] `_ - -LocalObjectReference contains enough information to let you locate the -referenced object inside the same namespace. - -.. code-block:: json - - { - "name": "..." - } - -.. _api_field_k8s.io.api.core.v1.LocalObjectReference.name: - -name - (`string `_) Name of the referent. - More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - TODO: Add other useful fields. apiVersion, kind, uid? - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.LocalVolumeSource: - -k8s.io.api.core.v1.LocalVolumeSource ------------------------------------- - -`[k8s.io.api.core.v1.LocalVolumeSource proto] `_ - -Local represents directly-attached storage with node affinity (Beta feature) - -.. code-block:: json - - { - "path": "...", - "fsType": "..." - } - -.. _api_field_k8s.io.api.core.v1.LocalVolumeSource.path: - -path - (`string `_) The full path to the volume on the node. - It can be either a directory or block device (disk, partition, ...). - - -.. _api_field_k8s.io.api.core.v1.LocalVolumeSource.fsType: - -fsType - (`string `_) Filesystem type to mount. - It applies only when the Path is a block device. - Must be a filesystem type supported by the host operating system. - Ex. "ext4", "xfs", "ntfs". The default value is to auto-select a fileystem if unspecified. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.NFSVolumeSource: - -k8s.io.api.core.v1.NFSVolumeSource ----------------------------------- - -`[k8s.io.api.core.v1.NFSVolumeSource proto] `_ - -Represents an NFS mount that lasts the lifetime of a pod. -NFS volumes do not support ownership management or SELinux relabeling. - -.. code-block:: json - - { - "server": "...", - "path": "...", - "readOnly": "..." - } - -.. _api_field_k8s.io.api.core.v1.NFSVolumeSource.server: - -server - (`string `_) Server is the hostname or IP address of the NFS server. - More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - - -.. _api_field_k8s.io.api.core.v1.NFSVolumeSource.path: - -path - (`string `_) Path that is exported by the NFS server. - More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - - -.. _api_field_k8s.io.api.core.v1.NFSVolumeSource.readOnly: - -readOnly - (`bool `_) ReadOnly here will force - the NFS export to be mounted with read-only permissions. - Defaults to false. - More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.Namespace: - -k8s.io.api.core.v1.Namespace ----------------------------- - -`[k8s.io.api.core.v1.Namespace proto] `_ - -Namespace provides a scope for Names. -Use of multiple namespaces is optional. - -.. code-block:: json - - { - "metadata": "{...}", - "spec": "{...}", - "status": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.Namespace.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.Namespace.spec: - -spec - (:ref:`k8s.io.api.core.v1.NamespaceSpec `) Spec defines the behavior of the Namespace. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - +optional - - -.. _api_field_k8s.io.api.core.v1.Namespace.status: - -status - (:ref:`k8s.io.api.core.v1.NamespaceStatus `) Status describes the current status of a Namespace. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.NamespaceList: - -k8s.io.api.core.v1.NamespaceList --------------------------------- - -`[k8s.io.api.core.v1.NamespaceList proto] `_ - -NamespaceList is a list of Namespaces. - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.NamespaceList.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.api.core.v1.NamespaceList.items: - -items - (:ref:`k8s.io.api.core.v1.Namespace `) Items is the list of Namespace objects in the list. - More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ - - - - -.. _api_msg_k8s.io.api.core.v1.NamespaceSpec: - -k8s.io.api.core.v1.NamespaceSpec --------------------------------- - -`[k8s.io.api.core.v1.NamespaceSpec proto] `_ - -NamespaceSpec describes the attributes on a Namespace. - -.. code-block:: json - - { - "finalizers": [] - } - -.. _api_field_k8s.io.api.core.v1.NamespaceSpec.finalizers: - -finalizers - (`string `_) Finalizers is an opaque list of values that must be empty to permanently remove object from storage. - More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.NamespaceStatus: - -k8s.io.api.core.v1.NamespaceStatus ----------------------------------- - -`[k8s.io.api.core.v1.NamespaceStatus proto] `_ - -NamespaceStatus is information about the current status of a Namespace. - -.. code-block:: json - - { - "phase": "..." - } - -.. _api_field_k8s.io.api.core.v1.NamespaceStatus.phase: - -phase - (`string `_) Phase is the current lifecycle phase of the namespace. - More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.Node: - -k8s.io.api.core.v1.Node ------------------------ - -`[k8s.io.api.core.v1.Node proto] `_ - -Node is a worker node in Kubernetes. -Each node will have a unique identifier in the cache (i.e. in etcd). - -.. code-block:: json - - { - "metadata": "{...}", - "spec": "{...}", - "status": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.Node.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.Node.spec: - -spec - (:ref:`k8s.io.api.core.v1.NodeSpec `) Spec defines the behavior of a node. - https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - +optional - - -.. _api_field_k8s.io.api.core.v1.Node.status: - -status - (:ref:`k8s.io.api.core.v1.NodeStatus `) Most recently observed status of the node. - Populated by the system. - Read-only. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.NodeAddress: - -k8s.io.api.core.v1.NodeAddress ------------------------------- - -`[k8s.io.api.core.v1.NodeAddress proto] `_ - -NodeAddress contains information for the node's address. - -.. code-block:: json - - { - "type": "...", - "address": "..." - } - -.. _api_field_k8s.io.api.core.v1.NodeAddress.type: - -type - (`string `_) Node address type, one of Hostname, ExternalIP or InternalIP. - - -.. _api_field_k8s.io.api.core.v1.NodeAddress.address: - -address - (`string `_) The node address. - - - - -.. _api_msg_k8s.io.api.core.v1.NodeAffinity: - -k8s.io.api.core.v1.NodeAffinity -------------------------------- - -`[k8s.io.api.core.v1.NodeAffinity proto] `_ - -Node affinity is a group of node affinity scheduling rules. - -.. code-block:: json - - { - "requiredDuringSchedulingIgnoredDuringExecution": "{...}", - "preferredDuringSchedulingIgnoredDuringExecution": [] - } - -.. _api_field_k8s.io.api.core.v1.NodeAffinity.requiredDuringSchedulingIgnoredDuringExecution: - -requiredDuringSchedulingIgnoredDuringExecution - (:ref:`k8s.io.api.core.v1.NodeSelector `) If the affinity requirements specified by this field are not met at - scheduling time, the pod will not be scheduled onto the node. - If the affinity requirements specified by this field cease to be met - at some point during pod execution (e.g. due to an update), the system - may or may not try to eventually evict the pod from its node. - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeAffinity.preferredDuringSchedulingIgnoredDuringExecution: - -preferredDuringSchedulingIgnoredDuringExecution - (:ref:`k8s.io.api.core.v1.PreferredSchedulingTerm `) The scheduler will prefer to schedule pods to nodes that satisfy - the affinity expressions specified by this field, but it may choose - a node that violates one or more of the expressions. The node that is - most preferred is the one with the greatest sum of weights, i.e. - for each node that meets all of the scheduling requirements (resource - request, requiredDuringScheduling affinity expressions, etc.), - compute a sum by iterating through the elements of this field and adding - "weight" to the sum if the node matches the corresponding matchExpressions; the - node(s) with the highest sum are the most preferred. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.NodeCondition: - -k8s.io.api.core.v1.NodeCondition --------------------------------- - -`[k8s.io.api.core.v1.NodeCondition proto] `_ - -NodeCondition contains condition information for a node. - -.. code-block:: json - - { - "type": "...", - "status": "...", - "lastHeartbeatTime": "{...}", - "lastTransitionTime": "{...}", - "reason": "...", - "message": "..." - } - -.. _api_field_k8s.io.api.core.v1.NodeCondition.type: - -type - (`string `_) Type of node condition. - - -.. _api_field_k8s.io.api.core.v1.NodeCondition.status: - -status - (`string `_) Status of the condition, one of True, False, Unknown. - - -.. _api_field_k8s.io.api.core.v1.NodeCondition.lastHeartbeatTime: - -lastHeartbeatTime - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) Last time we got an update on a given condition. - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeCondition.lastTransitionTime: - -lastTransitionTime - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) Last time the condition transit from one status to another. - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeCondition.reason: - -reason - (`string `_) (brief) reason for the condition's last transition. - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeCondition.message: - -message - (`string `_) Human readable message indicating details about last transition. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.NodeConfigSource: - -k8s.io.api.core.v1.NodeConfigSource ------------------------------------ - -`[k8s.io.api.core.v1.NodeConfigSource proto] `_ - -NodeConfigSource specifies a source of node configuration. Exactly one subfield (excluding metadata) must be non-nil. - -.. code-block:: json - - { - "configMap": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.NodeConfigSource.configMap: - -configMap - (:ref:`k8s.io.api.core.v1.ConfigMapNodeConfigSource `) ConfigMap is a reference to a Node's ConfigMap - - - - -.. _api_msg_k8s.io.api.core.v1.NodeConfigStatus: - -k8s.io.api.core.v1.NodeConfigStatus ------------------------------------ - -`[k8s.io.api.core.v1.NodeConfigStatus proto] `_ - -NodeConfigStatus describes the status of the config assigned by Node.Spec.ConfigSource. - -.. code-block:: json - - { - "assigned": "{...}", - "active": "{...}", - "lastKnownGood": "{...}", - "error": "..." - } - -.. _api_field_k8s.io.api.core.v1.NodeConfigStatus.assigned: - -assigned - (:ref:`k8s.io.api.core.v1.NodeConfigSource `) Assigned reports the checkpointed config the node will try to use. - When Node.Spec.ConfigSource is updated, the node checkpoints the associated - config payload to local disk, along with a record indicating intended - config. The node refers to this record to choose its config checkpoint, and - reports this record in Assigned. Assigned only updates in the status after - the record has been checkpointed to disk. When the Kubelet is restarted, - it tries to make the Assigned config the Active config by loading and - validating the checkpointed payload identified by Assigned. - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeConfigStatus.active: - -active - (:ref:`k8s.io.api.core.v1.NodeConfigSource `) Active reports the checkpointed config the node is actively using. - Active will represent either the current version of the Assigned config, - or the current LastKnownGood config, depending on whether attempting to use the - Assigned config results in an error. - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeConfigStatus.lastKnownGood: - -lastKnownGood - (:ref:`k8s.io.api.core.v1.NodeConfigSource `) LastKnownGood reports the checkpointed config the node will fall back to - when it encounters an error attempting to use the Assigned config. - The Assigned config becomes the LastKnownGood config when the node determines - that the Assigned config is stable and correct. - This is currently implemented as a 10-minute soak period starting when the local - record of Assigned config is updated. If the Assigned config is Active at the end - of this period, it becomes the LastKnownGood. Note that if Spec.ConfigSource is - reset to nil (use local defaults), the LastKnownGood is also immediately reset to nil, - because the local default config is always assumed good. - You should not make assumptions about the node's method of determining config stability - and correctness, as this may change or become configurable in the future. - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeConfigStatus.error: - -error - (`string `_) Error describes any problems reconciling the Spec.ConfigSource to the Active config. - Errors may occur, for example, attempting to checkpoint Spec.ConfigSource to the local Assigned - record, attempting to checkpoint the payload associated with Spec.ConfigSource, attempting - to load or validate the Assigned config, etc. - Errors may occur at different points while syncing config. Earlier errors (e.g. download or - checkpointing errors) will not result in a rollback to LastKnownGood, and may resolve across - Kubelet retries. Later errors (e.g. loading or validating a checkpointed config) will result in - a rollback to LastKnownGood. In the latter case, it is usually possible to resolve the error - by fixing the config assigned in Spec.ConfigSource. - You can find additional information for debugging by searching the error message in the Kubelet log. - Error is a human-readable description of the error state; machines can check whether or not Error - is empty, but should not rely on the stability of the Error text across Kubelet versions. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.NodeDaemonEndpoints: - -k8s.io.api.core.v1.NodeDaemonEndpoints --------------------------------------- - -`[k8s.io.api.core.v1.NodeDaemonEndpoints proto] `_ - -NodeDaemonEndpoints lists ports opened by daemons running on the Node. - -.. code-block:: json - - { - "kubeletEndpoint": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.NodeDaemonEndpoints.kubeletEndpoint: - -kubeletEndpoint - (:ref:`k8s.io.api.core.v1.DaemonEndpoint `) Endpoint on which Kubelet is listening. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.NodeList: - -k8s.io.api.core.v1.NodeList ---------------------------- - -`[k8s.io.api.core.v1.NodeList proto] `_ - -NodeList is the whole list of all Nodes which have been registered with master. - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.NodeList.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeList.items: - -items - (:ref:`k8s.io.api.core.v1.Node `) List of nodes - - - - -.. _api_msg_k8s.io.api.core.v1.NodeProxyOptions: - -k8s.io.api.core.v1.NodeProxyOptions ------------------------------------ - -`[k8s.io.api.core.v1.NodeProxyOptions proto] `_ - -NodeProxyOptions is the query options to a Node's proxy call. - -.. code-block:: json - - { - "path": "..." - } - -.. _api_field_k8s.io.api.core.v1.NodeProxyOptions.path: - -path - (`string `_) Path is the URL path to use for the current proxy request to node. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.NodeResources: - -k8s.io.api.core.v1.NodeResources --------------------------------- - -`[k8s.io.api.core.v1.NodeResources proto] `_ - -NodeResources is an object for conveying resource information about a node. -see http://releases.k8s.io/HEAD/docs/design/resources.md for more details. - -.. code-block:: json - - { - "capacity": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.NodeResources.capacity: - -capacity - (map<`string `_, :ref:`k8s.io.apimachinery.pkg.api.resource.Quantity `>) Capacity represents the available resources of a node - - - - -.. _api_msg_k8s.io.api.core.v1.NodeSelector: - -k8s.io.api.core.v1.NodeSelector -------------------------------- - -`[k8s.io.api.core.v1.NodeSelector proto] `_ - -A node selector represents the union of the results of one or more label queries -over a set of nodes; that is, it represents the OR of the selectors represented -by the node selector terms. - -.. code-block:: json - - { - "nodeSelectorTerms": [] - } - -.. _api_field_k8s.io.api.core.v1.NodeSelector.nodeSelectorTerms: - -nodeSelectorTerms - (:ref:`k8s.io.api.core.v1.NodeSelectorTerm `) Required. A list of node selector terms. The terms are ORed. - - - - -.. _api_msg_k8s.io.api.core.v1.NodeSelectorRequirement: - -k8s.io.api.core.v1.NodeSelectorRequirement ------------------------------------------- - -`[k8s.io.api.core.v1.NodeSelectorRequirement proto] `_ - -A node selector requirement is a selector that contains values, a key, and an operator -that relates the key and values. - -.. code-block:: json - - { - "key": "...", - "operator": "...", - "values": [] - } - -.. _api_field_k8s.io.api.core.v1.NodeSelectorRequirement.key: - -key - (`string `_) The label key that the selector applies to. - - -.. _api_field_k8s.io.api.core.v1.NodeSelectorRequirement.operator: - -operator - (`string `_) Represents a key's relationship to a set of values. - Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt. - - -.. _api_field_k8s.io.api.core.v1.NodeSelectorRequirement.values: - -values - (`string `_) An array of string values. If the operator is In or NotIn, - the values array must be non-empty. If the operator is Exists or DoesNotExist, - the values array must be empty. If the operator is Gt or Lt, the values - array must have a single element, which will be interpreted as an integer. - This array is replaced during a strategic merge patch. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.NodeSelectorTerm: - -k8s.io.api.core.v1.NodeSelectorTerm ------------------------------------ - -`[k8s.io.api.core.v1.NodeSelectorTerm proto] `_ - -A null or empty node selector term matches no objects. The requirements of -them are ANDed. -The TopologySelectorTerm type implements a subset of the NodeSelectorTerm. - -.. code-block:: json - - { - "matchExpressions": [], - "matchFields": [] - } - -.. _api_field_k8s.io.api.core.v1.NodeSelectorTerm.matchExpressions: - -matchExpressions - (:ref:`k8s.io.api.core.v1.NodeSelectorRequirement `) A list of node selector requirements by node's labels. - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeSelectorTerm.matchFields: - -matchFields - (:ref:`k8s.io.api.core.v1.NodeSelectorRequirement `) A list of node selector requirements by node's fields. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.NodeSpec: - -k8s.io.api.core.v1.NodeSpec ---------------------------- - -`[k8s.io.api.core.v1.NodeSpec proto] `_ - -NodeSpec describes the attributes that a node is created with. - -.. code-block:: json - - { - "podCIDR": "...", - "providerID": "...", - "unschedulable": "...", - "taints": [], - "configSource": "{...}", - "externalID": "..." - } - -.. _api_field_k8s.io.api.core.v1.NodeSpec.podCIDR: - -podCIDR - (`string `_) PodCIDR represents the pod IP range assigned to the node. - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeSpec.providerID: - -providerID - (`string `_) ID of the node assigned by the cloud provider in the format: :// - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeSpec.unschedulable: - -unschedulable - (`bool `_) Unschedulable controls node schedulability of new pods. By default, node is schedulable. - More info: https://kubernetes.io/docs/concepts/nodes/node/#manual-node-administration - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeSpec.taints: - -taints - (:ref:`k8s.io.api.core.v1.Taint `) If specified, the node's taints. - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeSpec.configSource: - -configSource - (:ref:`k8s.io.api.core.v1.NodeConfigSource `) If specified, the source to get node configuration from - The DynamicKubeletConfig feature gate must be enabled for the Kubelet to use this field - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeSpec.externalID: - -externalID - (`string `_) Deprecated. Not all kubelets will set this field. Remove field after 1.13. - see: https://issues.k8s.io/61966 - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.NodeStatus: - -k8s.io.api.core.v1.NodeStatus ------------------------------ - -`[k8s.io.api.core.v1.NodeStatus proto] `_ - -NodeStatus is information about the current status of a node. - -.. code-block:: json - - { - "capacity": "{...}", - "allocatable": "{...}", - "phase": "...", - "conditions": [], - "addresses": [], - "daemonEndpoints": "{...}", - "nodeInfo": "{...}", - "images": [], - "volumesInUse": [], - "volumesAttached": [], - "config": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.NodeStatus.capacity: - -capacity - (map<`string `_, :ref:`k8s.io.apimachinery.pkg.api.resource.Quantity `>) Capacity represents the total resources of a node. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeStatus.allocatable: - -allocatable - (map<`string `_, :ref:`k8s.io.apimachinery.pkg.api.resource.Quantity `>) Allocatable represents the resources of a node that are available for scheduling. - Defaults to Capacity. - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeStatus.phase: - -phase - (`string `_) NodePhase is the recently observed lifecycle phase of the node. - More info: https://kubernetes.io/docs/concepts/nodes/node/#phase - The field is never populated, and now is deprecated. - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeStatus.conditions: - -conditions - (:ref:`k8s.io.api.core.v1.NodeCondition `) Conditions is an array of current observed node conditions. - More info: https://kubernetes.io/docs/concepts/nodes/node/#condition - +optional - +patchMergeKey=type - +patchStrategy=merge - - -.. _api_field_k8s.io.api.core.v1.NodeStatus.addresses: - -addresses - (:ref:`k8s.io.api.core.v1.NodeAddress `) List of addresses reachable to the node. - Queried from cloud provider, if available. - More info: https://kubernetes.io/docs/concepts/nodes/node/#addresses - +optional - +patchMergeKey=type - +patchStrategy=merge - - -.. _api_field_k8s.io.api.core.v1.NodeStatus.daemonEndpoints: - -daemonEndpoints - (:ref:`k8s.io.api.core.v1.NodeDaemonEndpoints `) Endpoints of daemons running on the Node. - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeStatus.nodeInfo: - -nodeInfo - (:ref:`k8s.io.api.core.v1.NodeSystemInfo `) Set of ids/uuids to uniquely identify the node. - More info: https://kubernetes.io/docs/concepts/nodes/node/#info - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeStatus.images: - -images - (:ref:`k8s.io.api.core.v1.ContainerImage `) List of container images on this node - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeStatus.volumesInUse: - -volumesInUse - (`string `_) List of attachable volumes in use (mounted) by the node. - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeStatus.volumesAttached: - -volumesAttached - (:ref:`k8s.io.api.core.v1.AttachedVolume `) List of volumes that are attached to the node. - +optional - - -.. _api_field_k8s.io.api.core.v1.NodeStatus.config: - -config - (:ref:`k8s.io.api.core.v1.NodeConfigStatus `) Status of the config assigned to the node via the dynamic Kubelet config feature. - +optional - - - - - -.. _api_msg_k8s.io.api.core.v1.NodeSystemInfo: - -k8s.io.api.core.v1.NodeSystemInfo ---------------------------------- - -`[k8s.io.api.core.v1.NodeSystemInfo proto] `_ - -NodeSystemInfo is a set of ids/uuids to uniquely identify the node. - -.. code-block:: json - - { - "machineID": "...", - "systemUUID": "...", - "bootID": "...", - "kernelVersion": "...", - "osImage": "...", - "containerRuntimeVersion": "...", - "kubeletVersion": "...", - "kubeProxyVersion": "...", - "operatingSystem": "...", - "architecture": "..." - } - -.. _api_field_k8s.io.api.core.v1.NodeSystemInfo.machineID: - -machineID - (`string `_) MachineID reported by the node. For unique machine identification - in the cluster this field is preferred. Learn more from man(5) - machine-id: http://man7.org/linux/man-pages/man5/machine-id.5.html - - -.. _api_field_k8s.io.api.core.v1.NodeSystemInfo.systemUUID: - -systemUUID - (`string `_) SystemUUID reported by the node. For unique machine identification - MachineID is preferred. This field is specific to Red Hat hosts - https://access.redhat.com/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/getting-system-uuid.html - - -.. _api_field_k8s.io.api.core.v1.NodeSystemInfo.bootID: - -bootID - (`string `_) Boot ID reported by the node. - - -.. _api_field_k8s.io.api.core.v1.NodeSystemInfo.kernelVersion: - -kernelVersion - (`string `_) Kernel Version reported by the node from 'uname -r' (e.g. 3.16.0-0.bpo.4-amd64). - - -.. _api_field_k8s.io.api.core.v1.NodeSystemInfo.osImage: - -osImage - (`string `_) OS Image reported by the node from /etc/os-release (e.g. Debian GNU/Linux 7 (wheezy)). - - -.. _api_field_k8s.io.api.core.v1.NodeSystemInfo.containerRuntimeVersion: - -containerRuntimeVersion - (`string `_) ContainerRuntime Version reported by the node through runtime remote API (e.g. docker://1.5.0). - - -.. _api_field_k8s.io.api.core.v1.NodeSystemInfo.kubeletVersion: - -kubeletVersion - (`string `_) Kubelet Version reported by the node. - - -.. _api_field_k8s.io.api.core.v1.NodeSystemInfo.kubeProxyVersion: - -kubeProxyVersion - (`string `_) KubeProxy Version reported by the node. - - -.. _api_field_k8s.io.api.core.v1.NodeSystemInfo.operatingSystem: - -operatingSystem - (`string `_) The Operating System reported by the node - - -.. _api_field_k8s.io.api.core.v1.NodeSystemInfo.architecture: - -architecture - (`string `_) The Architecture reported by the node - - - - -.. _api_msg_k8s.io.api.core.v1.ObjectFieldSelector: - -k8s.io.api.core.v1.ObjectFieldSelector --------------------------------------- - -`[k8s.io.api.core.v1.ObjectFieldSelector proto] `_ - -ObjectFieldSelector selects an APIVersioned field of an object. - -.. code-block:: json - - { - "apiVersion": "...", - "fieldPath": "..." - } - -.. _api_field_k8s.io.api.core.v1.ObjectFieldSelector.apiVersion: - -apiVersion - (`string `_) Version of the schema the FieldPath is written in terms of, defaults to "v1". - +optional - - -.. _api_field_k8s.io.api.core.v1.ObjectFieldSelector.fieldPath: - -fieldPath - (`string `_) Path of the field to select in the specified API version. - - - - -.. _api_msg_k8s.io.api.core.v1.ObjectReference: - -k8s.io.api.core.v1.ObjectReference ----------------------------------- - -`[k8s.io.api.core.v1.ObjectReference proto] `_ - -ObjectReference contains enough information to let you inspect or modify the referred object. -+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object - -.. code-block:: json - - { - "kind": "...", - "namespace": "...", - "name": "...", - "uid": "...", - "apiVersion": "...", - "resourceVersion": "...", - "fieldPath": "..." - } - -.. _api_field_k8s.io.api.core.v1.ObjectReference.kind: - -kind - (`string `_) Kind of the referent. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.api.core.v1.ObjectReference.namespace: - -namespace - (`string `_) Namespace of the referent. - More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ - +optional - - -.. _api_field_k8s.io.api.core.v1.ObjectReference.name: - -name - (`string `_) Name of the referent. - More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - +optional - - -.. _api_field_k8s.io.api.core.v1.ObjectReference.uid: - -uid - (`string `_) UID of the referent. - More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids - +optional - - -.. _api_field_k8s.io.api.core.v1.ObjectReference.apiVersion: - -apiVersion - (`string `_) API version of the referent. - +optional - - -.. _api_field_k8s.io.api.core.v1.ObjectReference.resourceVersion: - -resourceVersion - (`string `_) Specific resourceVersion to which this reference is made, if any. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency - +optional - - -.. _api_field_k8s.io.api.core.v1.ObjectReference.fieldPath: - -fieldPath - (`string `_) If referring to a piece of an object instead of an entire object, this string - should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. - For example, if the object reference is to a container within a pod, this would take on a value like: - "spec.containers{name}" (where "name" refers to the name of the container that triggered - the event) or if no container name is specified "spec.containers[2]" (container with - index 2 in this pod). This syntax is chosen only to have some well-defined way of - referencing a part of an object. - TODO: this design is not final and this field is subject to change in the future. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PersistentVolume: - -k8s.io.api.core.v1.PersistentVolume ------------------------------------ - -`[k8s.io.api.core.v1.PersistentVolume proto] `_ - -PersistentVolume (PV) is a storage resource provisioned by an administrator. -It is analogous to a node. -More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes - -.. code-block:: json - - { - "metadata": "{...}", - "spec": "{...}", - "status": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.PersistentVolume.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolume.spec: - -spec - (:ref:`k8s.io.api.core.v1.PersistentVolumeSpec `) Spec defines a specification of a persistent volume owned by the cluster. - Provisioned by an administrator. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolume.status: - -status - (:ref:`k8s.io.api.core.v1.PersistentVolumeStatus `) Status represents the current information/status for the persistent volume. - Populated by the system. - Read-only. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistent-volumes - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PersistentVolumeClaim: - -k8s.io.api.core.v1.PersistentVolumeClaim ----------------------------------------- - -`[k8s.io.api.core.v1.PersistentVolumeClaim proto] `_ - -PersistentVolumeClaim is a user's request for and claim to a persistent volume - -.. code-block:: json - - { - "metadata": "{...}", - "spec": "{...}", - "status": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaim.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaim.spec: - -spec - (:ref:`k8s.io.api.core.v1.PersistentVolumeClaimSpec `) Spec defines the desired characteristics of a volume requested by a pod author. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaim.status: - -status - (:ref:`k8s.io.api.core.v1.PersistentVolumeClaimStatus `) Status represents the current information/status of a persistent volume claim. - Read-only. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PersistentVolumeClaimCondition: - -k8s.io.api.core.v1.PersistentVolumeClaimCondition -------------------------------------------------- - -`[k8s.io.api.core.v1.PersistentVolumeClaimCondition proto] `_ - -PersistentVolumeClaimCondition contails details about state of pvc - -.. code-block:: json - - { - "type": "...", - "status": "...", - "lastProbeTime": "{...}", - "lastTransitionTime": "{...}", - "reason": "...", - "message": "..." - } - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimCondition.type: - -type - (`string `_) - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimCondition.status: - -status - (`string `_) - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimCondition.lastProbeTime: - -lastProbeTime - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) Last time we probed the condition. - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimCondition.lastTransitionTime: - -lastTransitionTime - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) Last time the condition transitioned from one status to another. - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimCondition.reason: - -reason - (`string `_) Unique, this should be a short, machine understandable string that gives the reason - for condition's last transition. If it reports "ResizeStarted" that means the underlying - persistent volume is being resized. - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimCondition.message: - -message - (`string `_) Human-readable message indicating details about last transition. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PersistentVolumeClaimList: - -k8s.io.api.core.v1.PersistentVolumeClaimList --------------------------------------------- - -`[k8s.io.api.core.v1.PersistentVolumeClaimList proto] `_ - -PersistentVolumeClaimList is a list of PersistentVolumeClaim items. - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimList.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimList.items: - -items - (:ref:`k8s.io.api.core.v1.PersistentVolumeClaim `) A list of persistent volume claims. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - - - - -.. _api_msg_k8s.io.api.core.v1.PersistentVolumeClaimSpec: - -k8s.io.api.core.v1.PersistentVolumeClaimSpec --------------------------------------------- - -`[k8s.io.api.core.v1.PersistentVolumeClaimSpec proto] `_ - -PersistentVolumeClaimSpec describes the common attributes of storage devices -and allows a Source for provider-specific attributes - -.. code-block:: json - - { - "accessModes": [], - "selector": "{...}", - "resources": "{...}", - "volumeName": "...", - "storageClassName": "...", - "volumeMode": "...", - "dataSource": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimSpec.accessModes: - -accessModes - (`string `_) AccessModes contains the desired access modes the volume should have. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimSpec.selector: - -selector - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector `) A label query over volumes to consider for binding. - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimSpec.resources: - -resources - (:ref:`k8s.io.api.core.v1.ResourceRequirements `) Resources represents the minimum resources the volume should have. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimSpec.volumeName: - -volumeName - (`string `_) VolumeName is the binding reference to the PersistentVolume backing this claim. - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimSpec.storageClassName: - -storageClassName - (`string `_) Name of the StorageClass required by the claim. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1 - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimSpec.volumeMode: - -volumeMode - (`string `_) volumeMode defines what type of volume is required by the claim. - Value of Filesystem is implied when not included in claim spec. - This is a beta feature. - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimSpec.dataSource: - -dataSource - (:ref:`k8s.io.api.core.v1.TypedLocalObjectReference `) This field requires the VolumeSnapshotDataSource alpha feature gate to be - enabled and currently VolumeSnapshot is the only supported data source. - If the provisioner can support VolumeSnapshot data source, it will create - a new volume and data will be restored to the volume at the same time. - If the provisioner does not support VolumeSnapshot data source, volume will - not be created and the failure will be reported as an event. - In the future, we plan to support more data source types and the behavior - of the provisioner may change. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PersistentVolumeClaimStatus: - -k8s.io.api.core.v1.PersistentVolumeClaimStatus ----------------------------------------------- - -`[k8s.io.api.core.v1.PersistentVolumeClaimStatus proto] `_ - -PersistentVolumeClaimStatus is the current status of a persistent volume claim. - -.. code-block:: json - - { - "phase": "...", - "accessModes": [], - "capacity": "{...}", - "conditions": [] - } - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimStatus.phase: - -phase - (`string `_) Phase represents the current phase of PersistentVolumeClaim. - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimStatus.accessModes: - -accessModes - (`string `_) AccessModes contains the actual access modes the volume backing the PVC has. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1 - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimStatus.capacity: - -capacity - (map<`string `_, :ref:`k8s.io.apimachinery.pkg.api.resource.Quantity `>) Represents the actual resources of the underlying volume. - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimStatus.conditions: - -conditions - (:ref:`k8s.io.api.core.v1.PersistentVolumeClaimCondition `) Current Condition of persistent volume claim. If underlying persistent volume is being - resized then the Condition will be set to 'ResizeStarted'. - +optional - +patchMergeKey=type - +patchStrategy=merge - - - - -.. _api_msg_k8s.io.api.core.v1.PersistentVolumeClaimVolumeSource: - -k8s.io.api.core.v1.PersistentVolumeClaimVolumeSource ----------------------------------------------------- - -`[k8s.io.api.core.v1.PersistentVolumeClaimVolumeSource proto] `_ - -PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace. -This volume finds the bound PV and mounts that volume for the pod. A -PersistentVolumeClaimVolumeSource is, essentially, a wrapper around another -type of volume that is owned by someone else (the system). - -.. code-block:: json - - { - "claimName": "...", - "readOnly": "..." - } - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimVolumeSource.claimName: - -claimName - (`string `_) ClaimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeClaimVolumeSource.readOnly: - -readOnly - (`bool `_) Will force the ReadOnly setting in VolumeMounts. - Default false. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PersistentVolumeList: - -k8s.io.api.core.v1.PersistentVolumeList ---------------------------------------- - -`[k8s.io.api.core.v1.PersistentVolumeList proto] `_ - -PersistentVolumeList is a list of PersistentVolume items. - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeList.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeList.items: - -items - (:ref:`k8s.io.api.core.v1.PersistentVolume `) List of persistent volumes. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes - - - - -.. _api_msg_k8s.io.api.core.v1.PersistentVolumeSource: - -k8s.io.api.core.v1.PersistentVolumeSource ------------------------------------------ - -`[k8s.io.api.core.v1.PersistentVolumeSource proto] `_ - -PersistentVolumeSource is similar to VolumeSource but meant for the -administrator who creates PVs. Exactly one of its members must be set. - -.. code-block:: json - - { - "gcePersistentDisk": "{...}", - "awsElasticBlockStore": "{...}", - "hostPath": "{...}", - "glusterfs": "{...}", - "nfs": "{...}", - "rbd": "{...}", - "iscsi": "{...}", - "cinder": "{...}", - "cephfs": "{...}", - "fc": "{...}", - "flocker": "{...}", - "flexVolume": "{...}", - "azureFile": "{...}", - "vsphereVolume": "{...}", - "quobyte": "{...}", - "azureDisk": "{...}", - "photonPersistentDisk": "{...}", - "portworxVolume": "{...}", - "scaleIO": "{...}", - "local": "{...}", - "storageos": "{...}", - "csi": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.gcePersistentDisk: - -gcePersistentDisk - (:ref:`k8s.io.api.core.v1.GCEPersistentDiskVolumeSource `) GCEPersistentDisk represents a GCE Disk resource that is attached to a - kubelet's host machine and then exposed to the pod. Provisioned by an admin. - More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.awsElasticBlockStore: - -awsElasticBlockStore - (:ref:`k8s.io.api.core.v1.AWSElasticBlockStoreVolumeSource `) AWSElasticBlockStore represents an AWS Disk resource that is attached to a - kubelet's host machine and then exposed to the pod. - More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.hostPath: - -hostPath - (:ref:`k8s.io.api.core.v1.HostPathVolumeSource `) HostPath represents a directory on the host. - Provisioned by a developer or tester. - This is useful for single-node development and testing only! - On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. - More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.glusterfs: - -glusterfs - (:ref:`k8s.io.api.core.v1.GlusterfsPersistentVolumeSource `) Glusterfs represents a Glusterfs volume that is attached to a host and - exposed to the pod. Provisioned by an admin. - More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.nfs: - -nfs - (:ref:`k8s.io.api.core.v1.NFSVolumeSource `) NFS represents an NFS mount on the host. Provisioned by an admin. - More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.rbd: - -rbd - (:ref:`k8s.io.api.core.v1.RBDPersistentVolumeSource `) RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. - More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.iscsi: - -iscsi - (:ref:`k8s.io.api.core.v1.ISCSIPersistentVolumeSource `) ISCSI represents an ISCSI Disk resource that is attached to a - kubelet's host machine and then exposed to the pod. Provisioned by an admin. - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.cinder: - -cinder - (:ref:`k8s.io.api.core.v1.CinderPersistentVolumeSource `) Cinder represents a cinder volume attached and mounted on kubelets host machine - More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.cephfs: - -cephfs - (:ref:`k8s.io.api.core.v1.CephFSPersistentVolumeSource `) CephFS represents a Ceph FS mount on the host that shares a pod's lifetime - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.fc: - -fc - (:ref:`k8s.io.api.core.v1.FCVolumeSource `) FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.flocker: - -flocker - (:ref:`k8s.io.api.core.v1.FlockerVolumeSource `) Flocker represents a Flocker volume attached to a kubelet's host machine and exposed to the pod for its usage. This depends on the Flocker control service being running - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.flexVolume: - -flexVolume - (:ref:`k8s.io.api.core.v1.FlexPersistentVolumeSource `) FlexVolume represents a generic volume resource that is - provisioned/attached using an exec based plugin. - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.azureFile: - -azureFile - (:ref:`k8s.io.api.core.v1.AzureFilePersistentVolumeSource `) AzureFile represents an Azure File Service mount on the host and bind mount to the pod. - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.vsphereVolume: - -vsphereVolume - (:ref:`k8s.io.api.core.v1.VsphereVirtualDiskVolumeSource `) VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.quobyte: - -quobyte - (:ref:`k8s.io.api.core.v1.QuobyteVolumeSource `) Quobyte represents a Quobyte mount on the host that shares a pod's lifetime - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.azureDisk: - -azureDisk - (:ref:`k8s.io.api.core.v1.AzureDiskVolumeSource `) AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.photonPersistentDisk: - -photonPersistentDisk - (:ref:`k8s.io.api.core.v1.PhotonPersistentDiskVolumeSource `) PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.portworxVolume: - -portworxVolume - (:ref:`k8s.io.api.core.v1.PortworxVolumeSource `) PortworxVolume represents a portworx volume attached and mounted on kubelets host machine - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.scaleIO: - -scaleIO - (:ref:`k8s.io.api.core.v1.ScaleIOPersistentVolumeSource `) ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.local: - -local - (:ref:`k8s.io.api.core.v1.LocalVolumeSource `) Local represents directly-attached storage with node affinity - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.storageos: - -storageos - (:ref:`k8s.io.api.core.v1.StorageOSPersistentVolumeSource `) StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod - More info: https://releases.k8s.io/HEAD/examples/volumes/storageos/README.md - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSource.csi: - -csi - (:ref:`k8s.io.api.core.v1.CSIPersistentVolumeSource `) CSI represents storage that is handled by an external CSI driver (Beta feature). - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PersistentVolumeSpec: - -k8s.io.api.core.v1.PersistentVolumeSpec ---------------------------------------- - -`[k8s.io.api.core.v1.PersistentVolumeSpec proto] `_ - -PersistentVolumeSpec is the specification of a persistent volume. - -.. code-block:: json - - { - "capacity": "{...}", - "persistentVolumeSource": "{...}", - "accessModes": [], - "claimRef": "{...}", - "persistentVolumeReclaimPolicy": "...", - "storageClassName": "...", - "mountOptions": [], - "volumeMode": "...", - "nodeAffinity": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSpec.capacity: - -capacity - (map<`string `_, :ref:`k8s.io.apimachinery.pkg.api.resource.Quantity `>) A description of the persistent volume's resources and capacity. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSpec.persistentVolumeSource: - -persistentVolumeSource - (:ref:`k8s.io.api.core.v1.PersistentVolumeSource `) The actual volume backing the persistent volume. - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSpec.accessModes: - -accessModes - (`string `_) AccessModes contains all ways the volume can be mounted. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSpec.claimRef: - -claimRef - (:ref:`k8s.io.api.core.v1.ObjectReference `) ClaimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim. - Expected to be non-nil when bound. - claim.VolumeName is the authoritative bind between PV and PVC. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSpec.persistentVolumeReclaimPolicy: - -persistentVolumeReclaimPolicy - (`string `_) What happens to a persistent volume when released from its claim. - Valid options are Retain (default for manually created PersistentVolumes), Delete (default - for dynamically provisioned PersistentVolumes), and Recycle (deprecated). - Recycle must be supported by the volume plugin underlying this PersistentVolume. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSpec.storageClassName: - -storageClassName - (`string `_) Name of StorageClass to which this persistent volume belongs. Empty value - means that this volume does not belong to any StorageClass. - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSpec.mountOptions: - -mountOptions - (`string `_) A list of mount options, e.g. ["ro", "soft"]. Not validated - mount will - simply fail if one is invalid. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSpec.volumeMode: - -volumeMode - (`string `_) volumeMode defines if a volume is intended to be used with a formatted filesystem - or to remain in raw block state. Value of Filesystem is implied when not included in spec. - This is a beta feature. - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeSpec.nodeAffinity: - -nodeAffinity - (:ref:`k8s.io.api.core.v1.VolumeNodeAffinity `) NodeAffinity defines constraints that limit what nodes this volume can be accessed from. - This field influences the scheduling of pods that use this volume. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PersistentVolumeStatus: - -k8s.io.api.core.v1.PersistentVolumeStatus ------------------------------------------ - -`[k8s.io.api.core.v1.PersistentVolumeStatus proto] `_ - -PersistentVolumeStatus is the current status of a persistent volume. - -.. code-block:: json - - { - "phase": "...", - "message": "...", - "reason": "..." - } - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeStatus.phase: - -phase - (`string `_) Phase indicates if a volume is available, bound to a claim, or released by a claim. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#phase - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeStatus.message: - -message - (`string `_) A human-readable message indicating details about why the volume is in this state. - +optional - - -.. _api_field_k8s.io.api.core.v1.PersistentVolumeStatus.reason: - -reason - (`string `_) Reason is a brief CamelCase string that describes any failure and is meant - for machine parsing and tidy display in the CLI. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PhotonPersistentDiskVolumeSource: - -k8s.io.api.core.v1.PhotonPersistentDiskVolumeSource ---------------------------------------------------- - -`[k8s.io.api.core.v1.PhotonPersistentDiskVolumeSource proto] `_ - -Represents a Photon Controller persistent disk resource. - -.. code-block:: json - - { - "pdID": "...", - "fsType": "..." - } - -.. _api_field_k8s.io.api.core.v1.PhotonPersistentDiskVolumeSource.pdID: - -pdID - (`string `_) ID that identifies Photon Controller persistent disk - - -.. _api_field_k8s.io.api.core.v1.PhotonPersistentDiskVolumeSource.fsType: - -fsType - (`string `_) Filesystem type to mount. - Must be a filesystem type supported by the host operating system. - Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - - - - -.. _api_msg_k8s.io.api.core.v1.Pod: - -k8s.io.api.core.v1.Pod ----------------------- - -`[k8s.io.api.core.v1.Pod proto] `_ - -Pod is a collection of containers that can run on a host. This resource is created -by clients and scheduled onto hosts. - -.. code-block:: json - - { - "metadata": "{...}", - "spec": "{...}", - "status": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.Pod.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.Pod.spec: - -spec - (:ref:`k8s.io.api.core.v1.PodSpec `) Specification of the desired behavior of the pod. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - +optional - - -.. _api_field_k8s.io.api.core.v1.Pod.status: - -status - (:ref:`k8s.io.api.core.v1.PodStatus `) Most recently observed status of the pod. - This data may not be up to date. - Populated by the system. - Read-only. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PodAffinity: - -k8s.io.api.core.v1.PodAffinity ------------------------------- - -`[k8s.io.api.core.v1.PodAffinity proto] `_ - -Pod affinity is a group of inter pod affinity scheduling rules. - -.. code-block:: json - - { - "requiredDuringSchedulingIgnoredDuringExecution": [], - "preferredDuringSchedulingIgnoredDuringExecution": [] - } - -.. _api_field_k8s.io.api.core.v1.PodAffinity.requiredDuringSchedulingIgnoredDuringExecution: - -requiredDuringSchedulingIgnoredDuringExecution - (:ref:`k8s.io.api.core.v1.PodAffinityTerm `) If the affinity requirements specified by this field are not met at - scheduling time, the pod will not be scheduled onto the node. - If the affinity requirements specified by this field cease to be met - at some point during pod execution (e.g. due to a pod label update), the - system may or may not try to eventually evict the pod from its node. - When there are multiple elements, the lists of nodes corresponding to each - podAffinityTerm are intersected, i.e. all terms must be satisfied. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodAffinity.preferredDuringSchedulingIgnoredDuringExecution: - -preferredDuringSchedulingIgnoredDuringExecution - (:ref:`k8s.io.api.core.v1.WeightedPodAffinityTerm `) The scheduler will prefer to schedule pods to nodes that satisfy - the affinity expressions specified by this field, but it may choose - a node that violates one or more of the expressions. The node that is - most preferred is the one with the greatest sum of weights, i.e. - for each node that meets all of the scheduling requirements (resource - request, requiredDuringScheduling affinity expressions, etc.), - compute a sum by iterating through the elements of this field and adding - "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the - node(s) with the highest sum are the most preferred. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PodAffinityTerm: - -k8s.io.api.core.v1.PodAffinityTerm ----------------------------------- - -`[k8s.io.api.core.v1.PodAffinityTerm proto] `_ - -Defines a set of pods (namely those matching the labelSelector -relative to the given namespace(s)) that this pod should be -co-located (affinity) or not co-located (anti-affinity) with, -where co-located is defined as running on a node whose value of -the label with key matches that of any node on which -a pod of the set of pods is running - -.. code-block:: json - - { - "labelSelector": "{...}", - "namespaces": [], - "topologyKey": "..." - } - -.. _api_field_k8s.io.api.core.v1.PodAffinityTerm.labelSelector: - -labelSelector - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector `) A label query over a set of resources, in this case pods. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodAffinityTerm.namespaces: - -namespaces - (`string `_) namespaces specifies which namespaces the labelSelector applies to (matches against); - null or empty list means "this pod's namespace" - +optional - - -.. _api_field_k8s.io.api.core.v1.PodAffinityTerm.topologyKey: - -topologyKey - (`string `_) This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching - the labelSelector in the specified namespaces, where co-located is defined as running on a node - whose value of the label with key topologyKey matches that of any node on which any of the - selected pods is running. - Empty topologyKey is not allowed. - - - - -.. _api_msg_k8s.io.api.core.v1.PodAntiAffinity: - -k8s.io.api.core.v1.PodAntiAffinity ----------------------------------- - -`[k8s.io.api.core.v1.PodAntiAffinity proto] `_ - -Pod anti affinity is a group of inter pod anti affinity scheduling rules. - -.. code-block:: json - - { - "requiredDuringSchedulingIgnoredDuringExecution": [], - "preferredDuringSchedulingIgnoredDuringExecution": [] - } - -.. _api_field_k8s.io.api.core.v1.PodAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution: - -requiredDuringSchedulingIgnoredDuringExecution - (:ref:`k8s.io.api.core.v1.PodAffinityTerm `) If the anti-affinity requirements specified by this field are not met at - scheduling time, the pod will not be scheduled onto the node. - If the anti-affinity requirements specified by this field cease to be met - at some point during pod execution (e.g. due to a pod label update), the - system may or may not try to eventually evict the pod from its node. - When there are multiple elements, the lists of nodes corresponding to each - podAffinityTerm are intersected, i.e. all terms must be satisfied. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution: - -preferredDuringSchedulingIgnoredDuringExecution - (:ref:`k8s.io.api.core.v1.WeightedPodAffinityTerm `) The scheduler will prefer to schedule pods to nodes that satisfy - the anti-affinity expressions specified by this field, but it may choose - a node that violates one or more of the expressions. The node that is - most preferred is the one with the greatest sum of weights, i.e. - for each node that meets all of the scheduling requirements (resource - request, requiredDuringScheduling anti-affinity expressions, etc.), - compute a sum by iterating through the elements of this field and adding - "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the - node(s) with the highest sum are the most preferred. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PodAttachOptions: - -k8s.io.api.core.v1.PodAttachOptions ------------------------------------ - -`[k8s.io.api.core.v1.PodAttachOptions proto] `_ - -PodAttachOptions is the query options to a Pod's remote attach call. ---- -TODO: merge w/ PodExecOptions below for stdin, stdout, etc -and also when we cut V2, we should export a "StreamOptions" or somesuch that contains Stdin, Stdout, Stder and TTY - -.. code-block:: json - - { - "stdin": "...", - "stdout": "...", - "stderr": "...", - "tty": "...", - "container": "..." - } - -.. _api_field_k8s.io.api.core.v1.PodAttachOptions.stdin: - -stdin - (`bool `_) Stdin if true, redirects the standard input stream of the pod for this call. - Defaults to false. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodAttachOptions.stdout: - -stdout - (`bool `_) Stdout if true indicates that stdout is to be redirected for the attach call. - Defaults to true. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodAttachOptions.stderr: - -stderr - (`bool `_) Stderr if true indicates that stderr is to be redirected for the attach call. - Defaults to true. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodAttachOptions.tty: - -tty - (`bool `_) TTY if true indicates that a tty will be allocated for the attach call. - This is passed through the container runtime so the tty - is allocated on the worker node by the container runtime. - Defaults to false. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodAttachOptions.container: - -container - (`string `_) The container in which to execute the command. - Defaults to only container if there is only one container in the pod. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PodCondition: - -k8s.io.api.core.v1.PodCondition -------------------------------- - -`[k8s.io.api.core.v1.PodCondition proto] `_ - -PodCondition contains details for the current condition of this pod. - -.. code-block:: json - - { - "type": "...", - "status": "...", - "lastProbeTime": "{...}", - "lastTransitionTime": "{...}", - "reason": "...", - "message": "..." - } - -.. _api_field_k8s.io.api.core.v1.PodCondition.type: - -type - (`string `_) Type is the type of the condition. - More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions - - -.. _api_field_k8s.io.api.core.v1.PodCondition.status: - -status - (`string `_) Status is the status of the condition. - Can be True, False, Unknown. - More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions - - -.. _api_field_k8s.io.api.core.v1.PodCondition.lastProbeTime: - -lastProbeTime - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) Last time we probed the condition. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodCondition.lastTransitionTime: - -lastTransitionTime - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) Last time the condition transitioned from one status to another. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodCondition.reason: - -reason - (`string `_) Unique, one-word, CamelCase reason for the condition's last transition. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodCondition.message: - -message - (`string `_) Human-readable message indicating details about last transition. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PodDNSConfig: - -k8s.io.api.core.v1.PodDNSConfig -------------------------------- - -`[k8s.io.api.core.v1.PodDNSConfig proto] `_ - -PodDNSConfig defines the DNS parameters of a pod in addition to -those generated from DNSPolicy. - -.. code-block:: json - - { - "nameservers": [], - "searches": [], - "options": [] - } - -.. _api_field_k8s.io.api.core.v1.PodDNSConfig.nameservers: - -nameservers - (`string `_) A list of DNS name server IP addresses. - This will be appended to the base nameservers generated from DNSPolicy. - Duplicated nameservers will be removed. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodDNSConfig.searches: - -searches - (`string `_) A list of DNS search domains for host-name lookup. - This will be appended to the base search paths generated from DNSPolicy. - Duplicated search paths will be removed. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodDNSConfig.options: - -options - (:ref:`k8s.io.api.core.v1.PodDNSConfigOption `) A list of DNS resolver options. - This will be merged with the base options generated from DNSPolicy. - Duplicated entries will be removed. Resolution options given in Options - will override those that appear in the base DNSPolicy. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PodDNSConfigOption: - -k8s.io.api.core.v1.PodDNSConfigOption -------------------------------------- - -`[k8s.io.api.core.v1.PodDNSConfigOption proto] `_ - -PodDNSConfigOption defines DNS resolver options of a pod. - -.. code-block:: json - - { - "name": "...", - "value": "..." - } - -.. _api_field_k8s.io.api.core.v1.PodDNSConfigOption.name: - -name - (`string `_) Required. - - -.. _api_field_k8s.io.api.core.v1.PodDNSConfigOption.value: - -value - (`string `_) +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PodExecOptions: - -k8s.io.api.core.v1.PodExecOptions ---------------------------------- - -`[k8s.io.api.core.v1.PodExecOptions proto] `_ - -PodExecOptions is the query options to a Pod's remote exec call. ---- -TODO: This is largely identical to PodAttachOptions above, make sure they stay in sync and see about merging -and also when we cut V2, we should export a "StreamOptions" or somesuch that contains Stdin, Stdout, Stder and TTY - -.. code-block:: json - - { - "stdin": "...", - "stdout": "...", - "stderr": "...", - "tty": "...", - "container": "...", - "command": [] - } - -.. _api_field_k8s.io.api.core.v1.PodExecOptions.stdin: - -stdin - (`bool `_) Redirect the standard input stream of the pod for this call. - Defaults to false. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodExecOptions.stdout: - -stdout - (`bool `_) Redirect the standard output stream of the pod for this call. - Defaults to true. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodExecOptions.stderr: - -stderr - (`bool `_) Redirect the standard error stream of the pod for this call. - Defaults to true. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodExecOptions.tty: - -tty - (`bool `_) TTY if true indicates that a tty will be allocated for the exec call. - Defaults to false. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodExecOptions.container: - -container - (`string `_) Container in which to execute the command. - Defaults to only container if there is only one container in the pod. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodExecOptions.command: - -command - (`string `_) Command is the remote command to execute. argv array. Not executed within a shell. - - - - -.. _api_msg_k8s.io.api.core.v1.PodList: - -k8s.io.api.core.v1.PodList --------------------------- - -`[k8s.io.api.core.v1.PodList proto] `_ - -PodList is a list of Pods. - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.PodList.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.api.core.v1.PodList.items: - -items - (:ref:`k8s.io.api.core.v1.Pod `) List of pods. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md - - - - -.. _api_msg_k8s.io.api.core.v1.PodLogOptions: - -k8s.io.api.core.v1.PodLogOptions --------------------------------- - -`[k8s.io.api.core.v1.PodLogOptions proto] `_ - -PodLogOptions is the query options for a Pod's logs REST call. - -.. code-block:: json - - { - "container": "...", - "follow": "...", - "previous": "...", - "sinceSeconds": "...", - "sinceTime": "{...}", - "timestamps": "...", - "tailLines": "...", - "limitBytes": "..." - } - -.. _api_field_k8s.io.api.core.v1.PodLogOptions.container: - -container - (`string `_) The container for which to stream logs. Defaults to only container if there is one container in the pod. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodLogOptions.follow: - -follow - (`bool `_) Follow the log stream of the pod. Defaults to false. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodLogOptions.previous: - -previous - (`bool `_) Return previous terminated container logs. Defaults to false. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodLogOptions.sinceSeconds: - -sinceSeconds - (`int64 `_) A relative time in seconds before the current time from which to show logs. If this value - precedes the time a pod was started, only logs since the pod start will be returned. - If this value is in the future, no logs will be returned. - Only one of sinceSeconds or sinceTime may be specified. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodLogOptions.sinceTime: - -sinceTime - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) An RFC3339 timestamp from which to show logs. If this value - precedes the time a pod was started, only logs since the pod start will be returned. - If this value is in the future, no logs will be returned. - Only one of sinceSeconds or sinceTime may be specified. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodLogOptions.timestamps: - -timestamps - (`bool `_) If true, add an RFC3339 or RFC3339Nano timestamp at the beginning of every line - of log output. Defaults to false. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodLogOptions.tailLines: - -tailLines - (`int64 `_) If set, the number of lines from the end of the logs to show. If not specified, - logs are shown from the creation of the container or sinceSeconds or sinceTime - +optional - - -.. _api_field_k8s.io.api.core.v1.PodLogOptions.limitBytes: - -limitBytes - (`int64 `_) If set, the number of bytes to read from the server before terminating the - log output. This may not display a complete final line of logging, and may return - slightly more or slightly less than the specified limit. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PodPortForwardOptions: - -k8s.io.api.core.v1.PodPortForwardOptions ----------------------------------------- - -`[k8s.io.api.core.v1.PodPortForwardOptions proto] `_ - -PodPortForwardOptions is the query options to a Pod's port forward call -when using WebSockets. -The `port` query parameter must specify the port or -ports (comma separated) to forward over. -Port forwarding over SPDY does not use these options. It requires the port -to be passed in the `port` header as part of request. - -.. code-block:: json - - { - "ports": [] - } - -.. _api_field_k8s.io.api.core.v1.PodPortForwardOptions.ports: - -ports - (`int32 `_) List of ports to forward - Required when using WebSockets - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PodProxyOptions: - -k8s.io.api.core.v1.PodProxyOptions ----------------------------------- - -`[k8s.io.api.core.v1.PodProxyOptions proto] `_ - -PodProxyOptions is the query options to a Pod's proxy call. - -.. code-block:: json - - { - "path": "..." - } - -.. _api_field_k8s.io.api.core.v1.PodProxyOptions.path: - -path - (`string `_) Path is the URL path to use for the current proxy request to pod. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PodReadinessGate: - -k8s.io.api.core.v1.PodReadinessGate ------------------------------------ - -`[k8s.io.api.core.v1.PodReadinessGate proto] `_ - -PodReadinessGate contains the reference to a pod condition - -.. code-block:: json - - { - "conditionType": "..." - } - -.. _api_field_k8s.io.api.core.v1.PodReadinessGate.conditionType: - -conditionType - (`string `_) ConditionType refers to a condition in the pod's condition list with matching type. - - - - -.. _api_msg_k8s.io.api.core.v1.PodSecurityContext: - -k8s.io.api.core.v1.PodSecurityContext -------------------------------------- - -`[k8s.io.api.core.v1.PodSecurityContext proto] `_ - -PodSecurityContext holds pod-level security attributes and common container settings. -Some fields are also present in container.securityContext. Field values of -container.securityContext take precedence over field values of PodSecurityContext. - -.. code-block:: json - - { - "seLinuxOptions": "{...}", - "runAsUser": "...", - "runAsGroup": "...", - "runAsNonRoot": "...", - "supplementalGroups": [], - "fsGroup": "...", - "sysctls": [] - } - -.. _api_field_k8s.io.api.core.v1.PodSecurityContext.seLinuxOptions: - -seLinuxOptions - (:ref:`k8s.io.api.core.v1.SELinuxOptions `) The SELinux context to be applied to all containers. - If unspecified, the container runtime will allocate a random SELinux context for each - container. May also be set in SecurityContext. If set in - both SecurityContext and PodSecurityContext, the value specified in SecurityContext - takes precedence for that container. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSecurityContext.runAsUser: - -runAsUser - (`int64 `_) The UID to run the entrypoint of the container process. - Defaults to user specified in image metadata if unspecified. - May also be set in SecurityContext. If set in both SecurityContext and - PodSecurityContext, the value specified in SecurityContext takes precedence - for that container. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSecurityContext.runAsGroup: - -runAsGroup - (`int64 `_) The GID to run the entrypoint of the container process. - Uses runtime default if unset. - May also be set in SecurityContext. If set in both SecurityContext and - PodSecurityContext, the value specified in SecurityContext takes precedence - for that container. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSecurityContext.runAsNonRoot: - -runAsNonRoot - (`bool `_) Indicates that the container must run as a non-root user. - If true, the Kubelet will validate the image at runtime to ensure that it - does not run as UID 0 (root) and fail to start the container if it does. - If unset or false, no such validation will be performed. - May also be set in SecurityContext. If set in both SecurityContext and - PodSecurityContext, the value specified in SecurityContext takes precedence. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSecurityContext.supplementalGroups: - -supplementalGroups - (`int64 `_) A list of groups applied to the first process run in each container, in addition - to the container's primary GID. If unspecified, no groups will be added to - any container. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSecurityContext.fsGroup: - -fsGroup - (`int64 `_) A special supplemental group that applies to all containers in a pod. - Some volume types allow the Kubelet to change the ownership of that volume - to be owned by the pod: - - 1. The owning GID will be the FSGroup - 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) - 3. The permission bits are OR'd with rw-rw---- - - If unset, the Kubelet will not modify the ownership and permissions of any volume. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSecurityContext.sysctls: - -sysctls - (:ref:`k8s.io.api.core.v1.Sysctl `) Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported - sysctls (by the container runtime) might fail to launch. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PodSignature: - -k8s.io.api.core.v1.PodSignature -------------------------------- - -`[k8s.io.api.core.v1.PodSignature proto] `_ - -Describes the class of pods that should avoid this node. -Exactly one field should be set. - -.. code-block:: json - - { - "podController": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.PodSignature.podController: - -podController - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference `) Reference to controller whose pods should avoid this node. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PodSpec: - -k8s.io.api.core.v1.PodSpec --------------------------- - -`[k8s.io.api.core.v1.PodSpec proto] `_ - -PodSpec is a description of a pod. - -.. code-block:: json - - { - "volumes": [], - "initContainers": [], - "containers": [], - "restartPolicy": "...", - "terminationGracePeriodSeconds": "...", - "activeDeadlineSeconds": "...", - "dnsPolicy": "...", - "nodeSelector": "{...}", - "serviceAccountName": "...", - "serviceAccount": "...", - "automountServiceAccountToken": "...", - "nodeName": "...", - "hostNetwork": "...", - "hostPID": "...", - "hostIPC": "...", - "shareProcessNamespace": "...", - "securityContext": "{...}", - "imagePullSecrets": [], - "hostname": "...", - "subdomain": "...", - "affinity": "{...}", - "schedulerName": "...", - "tolerations": [], - "hostAliases": [], - "priorityClassName": "...", - "priority": "...", - "dnsConfig": "{...}", - "readinessGates": [], - "runtimeClassName": "...", - "enableServiceLinks": "..." - } - -.. _api_field_k8s.io.api.core.v1.PodSpec.volumes: - -volumes - (:ref:`k8s.io.api.core.v1.Volume `) List of volumes that can be mounted by containers belonging to the pod. - More info: https://kubernetes.io/docs/concepts/storage/volumes - +optional - +patchMergeKey=name - +patchStrategy=merge,retainKeys - - -.. _api_field_k8s.io.api.core.v1.PodSpec.initContainers: - -initContainers - (:ref:`k8s.io.api.core.v1.Container `) List of initialization containers belonging to the pod. - Init containers are executed in order prior to containers being started. If any - init container fails, the pod is considered to have failed and is handled according - to its restartPolicy. The name for an init container or normal container must be - unique among all containers. - Init containers may not have Lifecycle actions, Readiness probes, or Liveness probes. - The resourceRequirements of an init container are taken into account during scheduling - by finding the highest request/limit for each resource type, and then using the max of - of that value or the sum of the normal containers. Limits are applied to init containers - in a similar fashion. - Init containers cannot currently be added or removed. - Cannot be updated. - More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ - +patchMergeKey=name - +patchStrategy=merge - - -.. _api_field_k8s.io.api.core.v1.PodSpec.containers: - -containers - (:ref:`k8s.io.api.core.v1.Container `) List of containers belonging to the pod. - Containers cannot currently be added or removed. - There must be at least one container in a Pod. - Cannot be updated. - +patchMergeKey=name - +patchStrategy=merge - - -.. _api_field_k8s.io.api.core.v1.PodSpec.restartPolicy: - -restartPolicy - (`string `_) Restart policy for all containers within the pod. - One of Always, OnFailure, Never. - Default to Always. - More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#restart-policy - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.terminationGracePeriodSeconds: - -terminationGracePeriodSeconds - (`int64 `_) Optional duration in seconds the pod needs to terminate gracefully. May be decreased in delete request. - Value must be non-negative integer. The value zero indicates delete immediately. - If this value is nil, the default grace period will be used instead. - The grace period is the duration in seconds after the processes running in the pod are sent - a termination signal and the time when the processes are forcibly halted with a kill signal. - Set this value longer than the expected cleanup time for your process. - Defaults to 30 seconds. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.activeDeadlineSeconds: - -activeDeadlineSeconds - (`int64 `_) Optional duration in seconds the pod may be active on the node relative to - StartTime before the system will actively try to mark it failed and kill associated containers. - Value must be a positive integer. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.dnsPolicy: - -dnsPolicy - (`string `_) Set DNS policy for the pod. - Defaults to "ClusterFirst". - Valid values are 'ClusterFirstWithHostNet', 'ClusterFirst', 'Default' or 'None'. - DNS parameters given in DNSConfig will be merged with the policy selected with DNSPolicy. - To have DNS options set along with hostNetwork, you have to specify DNS policy - explicitly to 'ClusterFirstWithHostNet'. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.nodeSelector: - -nodeSelector - (map<`string `_, `string `_>) NodeSelector is a selector which must be true for the pod to fit on a node. - Selector which must match a node's labels for the pod to be scheduled on that node. - More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.serviceAccountName: - -serviceAccountName - (`string `_) ServiceAccountName is the name of the ServiceAccount to use to run this pod. - More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.serviceAccount: - -serviceAccount - (`string `_) DeprecatedServiceAccount is a depreciated alias for ServiceAccountName. - Deprecated: Use serviceAccountName instead. - +k8s:conversion-gen=false - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.automountServiceAccountToken: - -automountServiceAccountToken - (`bool `_) AutomountServiceAccountToken indicates whether a service account token should be automatically mounted. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.nodeName: - -nodeName - (`string `_) NodeName is a request to schedule this pod onto a specific node. If it is non-empty, - the scheduler simply schedules this pod onto that node, assuming that it fits resource - requirements. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.hostNetwork: - -hostNetwork - (`bool `_) Host networking requested for this pod. Use the host's network namespace. - If this option is set, the ports that will be used must be specified. - Default to false. - +k8s:conversion-gen=false - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.hostPID: - -hostPID - (`bool `_) Use the host's pid namespace. - Optional: Default to false. - +k8s:conversion-gen=false - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.hostIPC: - -hostIPC - (`bool `_) Use the host's ipc namespace. - Optional: Default to false. - +k8s:conversion-gen=false - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.shareProcessNamespace: - -shareProcessNamespace - (`bool `_) Share a single process namespace between all of the containers in a pod. - When this is set containers will be able to view and signal processes from other containers - in the same pod, and the first process in each container will not be assigned PID 1. - HostPID and ShareProcessNamespace cannot both be set. - Optional: Default to false. - This field is beta-level and may be disabled with the PodShareProcessNamespace feature. - +k8s:conversion-gen=false - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.securityContext: - -securityContext - (:ref:`k8s.io.api.core.v1.PodSecurityContext `) SecurityContext holds pod-level security attributes and common container settings. - Optional: Defaults to empty. See type description for default values of each field. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.imagePullSecrets: - -imagePullSecrets - (:ref:`k8s.io.api.core.v1.LocalObjectReference `) ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. - If specified, these secrets will be passed to individual puller implementations for them to use. For example, - in the case of docker, only DockerConfig type secrets are honored. - More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod - +optional - +patchMergeKey=name - +patchStrategy=merge - - -.. _api_field_k8s.io.api.core.v1.PodSpec.hostname: - -hostname - (`string `_) Specifies the hostname of the Pod - If not specified, the pod's hostname will be set to a system-defined value. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.subdomain: - -subdomain - (`string `_) If specified, the fully qualified Pod hostname will be "...svc.". - If not specified, the pod will not have a domainname at all. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.affinity: - -affinity - (:ref:`k8s.io.api.core.v1.Affinity `) If specified, the pod's scheduling constraints - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.schedulerName: - -schedulerName - (`string `_) If specified, the pod will be dispatched by specified scheduler. - If not specified, the pod will be dispatched by default scheduler. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.tolerations: - -tolerations - (:ref:`k8s.io.api.core.v1.Toleration `) If specified, the pod's tolerations. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.hostAliases: - -hostAliases - (:ref:`k8s.io.api.core.v1.HostAlias `) HostAliases is an optional list of hosts and IPs that will be injected into the pod's hosts - file if specified. This is only valid for non-hostNetwork pods. - +optional - +patchMergeKey=ip - +patchStrategy=merge - - -.. _api_field_k8s.io.api.core.v1.PodSpec.priorityClassName: - -priorityClassName - (`string `_) If specified, indicates the pod's priority. "system-node-critical" and - "system-cluster-critical" are two special keywords which indicate the - highest priorities with the former being the highest priority. Any other - name must be defined by creating a PriorityClass object with that name. - If not specified, the pod priority will be default or zero if there is no - default. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.priority: - -priority - (`int32 `_) The priority value. Various system components use this field to find the - priority of the pod. When Priority Admission Controller is enabled, it - prevents users from setting this field. The admission controller populates - this field from PriorityClassName. - The higher the value, the higher the priority. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.dnsConfig: - -dnsConfig - (:ref:`k8s.io.api.core.v1.PodDNSConfig `) Specifies the DNS parameters of a pod. - Parameters specified here will be merged to the generated DNS - configuration based on DNSPolicy. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.readinessGates: - -readinessGates - (:ref:`k8s.io.api.core.v1.PodReadinessGate `) If specified, all readiness gates will be evaluated for pod readiness. - A pod is ready when all its containers are ready AND - all conditions specified in the readiness gates have status equal to "True" - More info: https://git.k8s.io/enhancements/keps/sig-network/0007-pod-ready%2B%2B.md - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.runtimeClassName: - -runtimeClassName - (`string `_) RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used - to run this pod. If no RuntimeClass resource matches the named class, the pod will not be run. - If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an - empty definition that uses the default runtime handler. - More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md - This is an alpha feature and may change in the future. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodSpec.enableServiceLinks: - -enableServiceLinks - (`bool `_) EnableServiceLinks indicates whether information about services should be injected into pod's - environment variables, matching the syntax of Docker links. - Optional: Defaults to true. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PodStatus: - -k8s.io.api.core.v1.PodStatus ----------------------------- - -`[k8s.io.api.core.v1.PodStatus proto] `_ - -PodStatus represents information about the status of a pod. Status may trail the actual -state of a system, especially if the node that hosts the pod cannot contact the control -plane. - -.. code-block:: json - - { - "phase": "...", - "conditions": [], - "message": "...", - "reason": "...", - "nominatedNodeName": "...", - "hostIP": "...", - "podIP": "...", - "startTime": "{...}", - "initContainerStatuses": [], - "containerStatuses": [], - "qosClass": "..." - } - -.. _api_field_k8s.io.api.core.v1.PodStatus.phase: - -phase - (`string `_) The phase of a Pod is a simple, high-level summary of where the Pod is in its lifecycle. - The conditions array, the reason and message fields, and the individual container status - arrays contain more detail about the pod's status. - There are five possible phase values: - - Pending: The pod has been accepted by the Kubernetes system, but one or more of the - container images has not been created. This includes time before being scheduled as - well as time spent downloading images over the network, which could take a while. - Running: The pod has been bound to a node, and all of the containers have been created. - At least one container is still running, or is in the process of starting or restarting. - Succeeded: All containers in the pod have terminated in success, and will not be restarted. - Failed: All containers in the pod have terminated, and at least one container has - terminated in failure. The container either exited with non-zero status or was terminated - by the system. - Unknown: For some reason the state of the pod could not be obtained, typically due to an - error in communicating with the host of the pod. - - More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-phase - +optional - - -.. _api_field_k8s.io.api.core.v1.PodStatus.conditions: - -conditions - (:ref:`k8s.io.api.core.v1.PodCondition `) Current service state of pod. - More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-conditions - +optional - +patchMergeKey=type - +patchStrategy=merge - - -.. _api_field_k8s.io.api.core.v1.PodStatus.message: - -message - (`string `_) A human readable message indicating details about why the pod is in this condition. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodStatus.reason: - -reason - (`string `_) A brief CamelCase message indicating details about why the pod is in this state. - e.g. 'Evicted' - +optional - - -.. _api_field_k8s.io.api.core.v1.PodStatus.nominatedNodeName: - -nominatedNodeName - (`string `_) nominatedNodeName is set only when this pod preempts other pods on the node, but it cannot be - scheduled right away as preemption victims receive their graceful termination periods. - This field does not guarantee that the pod will be scheduled on this node. Scheduler may decide - to place the pod elsewhere if other nodes become available sooner. Scheduler may also decide to - give the resources on this node to a higher priority pod that is created after preemption. - As a result, this field may be different than PodSpec.nodeName when the pod is - scheduled. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodStatus.hostIP: - -hostIP - (`string `_) IP address of the host to which the pod is assigned. Empty if not yet scheduled. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodStatus.podIP: - -podIP - (`string `_) IP address allocated to the pod. Routable at least within the cluster. - Empty if not yet allocated. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodStatus.startTime: - -startTime - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) RFC 3339 date and time at which the object was acknowledged by the Kubelet. - This is before the Kubelet pulled the container image(s) for the pod. - +optional - - -.. _api_field_k8s.io.api.core.v1.PodStatus.initContainerStatuses: - -initContainerStatuses - (:ref:`k8s.io.api.core.v1.ContainerStatus `) The list has one entry per init container in the manifest. The most recent successful - init container will have ready = true, the most recently started container will have - startTime set. - More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status - - -.. _api_field_k8s.io.api.core.v1.PodStatus.containerStatuses: - -containerStatuses - (:ref:`k8s.io.api.core.v1.ContainerStatus `) The list has one entry per container in the manifest. Each entry is currently the output - of `docker inspect`. - More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#pod-and-container-status - +optional - - -.. _api_field_k8s.io.api.core.v1.PodStatus.qosClass: - -qosClass - (`string `_) The Quality of Service (QOS) classification assigned to the pod based on resource requirements - See PodQOSClass type for available QOS classes - More info: https://git.k8s.io/community/contributors/design-proposals/node/resource-qos.md - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PodStatusResult: - -k8s.io.api.core.v1.PodStatusResult ----------------------------------- - -`[k8s.io.api.core.v1.PodStatusResult proto] `_ - -PodStatusResult is a wrapper for PodStatus returned by kubelet that can be encode/decoded - -.. code-block:: json - - { - "metadata": "{...}", - "status": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.PodStatusResult.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.PodStatusResult.status: - -status - (:ref:`k8s.io.api.core.v1.PodStatus `) Most recently observed status of the pod. - This data may not be up to date. - Populated by the system. - Read-only. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PodTemplate: - -k8s.io.api.core.v1.PodTemplate ------------------------------- - -`[k8s.io.api.core.v1.PodTemplate proto] `_ - -PodTemplate describes a template for creating copies of a predefined pod. - -.. code-block:: json - - { - "metadata": "{...}", - "template": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.PodTemplate.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.PodTemplate.template: - -template - (:ref:`k8s.io.api.core.v1.PodTemplateSpec `) Template defines the pods that will be created from this pod template. - https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PodTemplateList: - -k8s.io.api.core.v1.PodTemplateList ----------------------------------- - -`[k8s.io.api.core.v1.PodTemplateList proto] `_ - -PodTemplateList is a list of PodTemplates. - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.PodTemplateList.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.api.core.v1.PodTemplateList.items: - -items - (:ref:`k8s.io.api.core.v1.PodTemplate `) List of pod templates - - - - -.. _api_msg_k8s.io.api.core.v1.PodTemplateSpec: - -k8s.io.api.core.v1.PodTemplateSpec ----------------------------------- - -`[k8s.io.api.core.v1.PodTemplateSpec proto] `_ - -PodTemplateSpec describes the data a pod should have when created from a template - -.. code-block:: json - - { - "metadata": "{...}", - "spec": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.PodTemplateSpec.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.PodTemplateSpec.spec: - -spec - (:ref:`k8s.io.api.core.v1.PodSpec `) Specification of the desired behavior of the pod. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PortworxVolumeSource: - -k8s.io.api.core.v1.PortworxVolumeSource ---------------------------------------- - -`[k8s.io.api.core.v1.PortworxVolumeSource proto] `_ - -PortworxVolumeSource represents a Portworx volume resource. - -.. code-block:: json - - { - "volumeID": "...", - "fsType": "...", - "readOnly": "..." - } - -.. _api_field_k8s.io.api.core.v1.PortworxVolumeSource.volumeID: - -volumeID - (`string `_) VolumeID uniquely identifies a Portworx volume - - -.. _api_field_k8s.io.api.core.v1.PortworxVolumeSource.fsType: - -fsType - (`string `_) FSType represents the filesystem type to mount - Must be a filesystem type supported by the host operating system. - Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified. - - -.. _api_field_k8s.io.api.core.v1.PortworxVolumeSource.readOnly: - -readOnly - (`bool `_) Defaults to false (read/write). ReadOnly here will force - the ReadOnly setting in VolumeMounts. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.Preconditions: - -k8s.io.api.core.v1.Preconditions --------------------------------- - -`[k8s.io.api.core.v1.Preconditions proto] `_ - -Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out. -+k8s:openapi-gen=false - -.. code-block:: json - - { - "uid": "..." - } - -.. _api_field_k8s.io.api.core.v1.Preconditions.uid: - -uid - (`string `_) Specifies the target UID. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PreferAvoidPodsEntry: - -k8s.io.api.core.v1.PreferAvoidPodsEntry ---------------------------------------- - -`[k8s.io.api.core.v1.PreferAvoidPodsEntry proto] `_ - -Describes a class of pods that should avoid this node. - -.. code-block:: json - - { - "podSignature": "{...}", - "evictionTime": "{...}", - "reason": "...", - "message": "..." - } - -.. _api_field_k8s.io.api.core.v1.PreferAvoidPodsEntry.podSignature: - -podSignature - (:ref:`k8s.io.api.core.v1.PodSignature `) The class of pods. - - -.. _api_field_k8s.io.api.core.v1.PreferAvoidPodsEntry.evictionTime: - -evictionTime - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) Time at which this entry was added to the list. - +optional - - -.. _api_field_k8s.io.api.core.v1.PreferAvoidPodsEntry.reason: - -reason - (`string `_) (brief) reason why this entry was added to the list. - +optional - - -.. _api_field_k8s.io.api.core.v1.PreferAvoidPodsEntry.message: - -message - (`string `_) Human readable message indicating why this entry was added to the list. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.PreferredSchedulingTerm: - -k8s.io.api.core.v1.PreferredSchedulingTerm ------------------------------------------- - -`[k8s.io.api.core.v1.PreferredSchedulingTerm proto] `_ - -An empty preferred scheduling term matches all objects with implicit weight 0 -(i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op). - -.. code-block:: json - - { - "weight": "...", - "preference": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.PreferredSchedulingTerm.weight: - -weight - (`int32 `_) Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100. - - -.. _api_field_k8s.io.api.core.v1.PreferredSchedulingTerm.preference: - -preference - (:ref:`k8s.io.api.core.v1.NodeSelectorTerm `) A node selector term, associated with the corresponding weight. - - - - -.. _api_msg_k8s.io.api.core.v1.Probe: - -k8s.io.api.core.v1.Probe ------------------------- - -`[k8s.io.api.core.v1.Probe proto] `_ - -Probe describes a health check to be performed against a container to determine whether it is -alive or ready to receive traffic. - -.. code-block:: json - - { - "handler": "{...}", - "initialDelaySeconds": "...", - "timeoutSeconds": "...", - "periodSeconds": "...", - "successThreshold": "...", - "failureThreshold": "..." - } - -.. _api_field_k8s.io.api.core.v1.Probe.handler: - -handler - (:ref:`k8s.io.api.core.v1.Handler `) The action taken to determine the health of a container - - -.. _api_field_k8s.io.api.core.v1.Probe.initialDelaySeconds: - -initialDelaySeconds - (`int32 `_) Number of seconds after the container has started before liveness probes are initiated. - More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - +optional - - -.. _api_field_k8s.io.api.core.v1.Probe.timeoutSeconds: - -timeoutSeconds - (`int32 `_) Number of seconds after which the probe times out. - Defaults to 1 second. Minimum value is 1. - More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes - +optional - - -.. _api_field_k8s.io.api.core.v1.Probe.periodSeconds: - -periodSeconds - (`int32 `_) How often (in seconds) to perform the probe. - Default to 10 seconds. Minimum value is 1. - +optional - - -.. _api_field_k8s.io.api.core.v1.Probe.successThreshold: - -successThreshold - (`int32 `_) Minimum consecutive successes for the probe to be considered successful after having failed. - Defaults to 1. Must be 1 for liveness. Minimum value is 1. - +optional - - -.. _api_field_k8s.io.api.core.v1.Probe.failureThreshold: - -failureThreshold - (`int32 `_) Minimum consecutive failures for the probe to be considered failed after having succeeded. - Defaults to 3. Minimum value is 1. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ProjectedVolumeSource: - -k8s.io.api.core.v1.ProjectedVolumeSource ----------------------------------------- - -`[k8s.io.api.core.v1.ProjectedVolumeSource proto] `_ - -Represents a projected volume source - -.. code-block:: json - - { - "sources": [], - "defaultMode": "..." - } - -.. _api_field_k8s.io.api.core.v1.ProjectedVolumeSource.sources: - -sources - (:ref:`k8s.io.api.core.v1.VolumeProjection `) list of volume projections - - -.. _api_field_k8s.io.api.core.v1.ProjectedVolumeSource.defaultMode: - -defaultMode - (`int32 `_) Mode bits to use on created files by default. Must be a value between - 0 and 0777. - Directories within the path are not affected by this setting. - This might be in conflict with other options that affect the file - mode, like fsGroup, and the result can be other mode bits set. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.QuobyteVolumeSource: - -k8s.io.api.core.v1.QuobyteVolumeSource --------------------------------------- - -`[k8s.io.api.core.v1.QuobyteVolumeSource proto] `_ - -Represents a Quobyte mount that lasts the lifetime of a pod. -Quobyte volumes do not support ownership management or SELinux relabeling. - -.. code-block:: json - - { - "registry": "...", - "volume": "...", - "readOnly": "...", - "user": "...", - "group": "...", - "tenant": "..." - } - -.. _api_field_k8s.io.api.core.v1.QuobyteVolumeSource.registry: - -registry - (`string `_) Registry represents a single or multiple Quobyte Registry services - specified as a string as host:port pair (multiple entries are separated with commas) - which acts as the central registry for volumes - - -.. _api_field_k8s.io.api.core.v1.QuobyteVolumeSource.volume: - -volume - (`string `_) Volume is a string that references an already created Quobyte volume by name. - - -.. _api_field_k8s.io.api.core.v1.QuobyteVolumeSource.readOnly: - -readOnly - (`bool `_) ReadOnly here will force the Quobyte volume to be mounted with read-only permissions. - Defaults to false. - +optional - - -.. _api_field_k8s.io.api.core.v1.QuobyteVolumeSource.user: - -user - (`string `_) User to map volume access to - Defaults to serivceaccount user - +optional - - -.. _api_field_k8s.io.api.core.v1.QuobyteVolumeSource.group: - -group - (`string `_) Group to map volume access to - Default is no group - +optional - - -.. _api_field_k8s.io.api.core.v1.QuobyteVolumeSource.tenant: - -tenant - (`string `_) Tenant owning the given Quobyte volume in the Backend - Used with dynamically provisioned Quobyte volumes, value is set by the plugin - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.RBDPersistentVolumeSource: - -k8s.io.api.core.v1.RBDPersistentVolumeSource --------------------------------------------- - -`[k8s.io.api.core.v1.RBDPersistentVolumeSource proto] `_ - -Represents a Rados Block Device mount that lasts the lifetime of a pod. -RBD volumes support ownership management and SELinux relabeling. - -.. code-block:: json - - { - "monitors": [], - "image": "...", - "fsType": "...", - "pool": "...", - "user": "...", - "keyring": "...", - "secretRef": "{...}", - "readOnly": "..." - } - -.. _api_field_k8s.io.api.core.v1.RBDPersistentVolumeSource.monitors: - -monitors - (`string `_) A collection of Ceph monitors. - More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it - - -.. _api_field_k8s.io.api.core.v1.RBDPersistentVolumeSource.image: - -image - (`string `_) The rados image name. - More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it - - -.. _api_field_k8s.io.api.core.v1.RBDPersistentVolumeSource.fsType: - -fsType - (`string `_) Filesystem type of the volume that you want to mount. - Tip: Ensure that the filesystem type is supported by the host operating system. - Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd - TODO: how do we prevent errors in the filesystem from compromising the machine - +optional - - -.. _api_field_k8s.io.api.core.v1.RBDPersistentVolumeSource.pool: - -pool - (`string `_) The rados pool name. - Default is rbd. - More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it - +optional - - -.. _api_field_k8s.io.api.core.v1.RBDPersistentVolumeSource.user: - -user - (`string `_) The rados user name. - Default is admin. - More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it - +optional - - -.. _api_field_k8s.io.api.core.v1.RBDPersistentVolumeSource.keyring: - -keyring - (`string `_) Keyring is the path to key ring for RBDUser. - Default is /etc/ceph/keyring. - More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it - +optional - - -.. _api_field_k8s.io.api.core.v1.RBDPersistentVolumeSource.secretRef: - -secretRef - (:ref:`k8s.io.api.core.v1.SecretReference `) SecretRef is name of the authentication secret for RBDUser. If provided - overrides keyring. - Default is nil. - More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it - +optional - - -.. _api_field_k8s.io.api.core.v1.RBDPersistentVolumeSource.readOnly: - -readOnly - (`bool `_) ReadOnly here will force the ReadOnly setting in VolumeMounts. - Defaults to false. - More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.RBDVolumeSource: - -k8s.io.api.core.v1.RBDVolumeSource ----------------------------------- - -`[k8s.io.api.core.v1.RBDVolumeSource proto] `_ - -Represents a Rados Block Device mount that lasts the lifetime of a pod. -RBD volumes support ownership management and SELinux relabeling. - -.. code-block:: json - - { - "monitors": [], - "image": "...", - "fsType": "...", - "pool": "...", - "user": "...", - "keyring": "...", - "secretRef": "{...}", - "readOnly": "..." - } - -.. _api_field_k8s.io.api.core.v1.RBDVolumeSource.monitors: - -monitors - (`string `_) A collection of Ceph monitors. - More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it - - -.. _api_field_k8s.io.api.core.v1.RBDVolumeSource.image: - -image - (`string `_) The rados image name. - More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it - - -.. _api_field_k8s.io.api.core.v1.RBDVolumeSource.fsType: - -fsType - (`string `_) Filesystem type of the volume that you want to mount. - Tip: Ensure that the filesystem type is supported by the host operating system. - Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd - TODO: how do we prevent errors in the filesystem from compromising the machine - +optional - - -.. _api_field_k8s.io.api.core.v1.RBDVolumeSource.pool: - -pool - (`string `_) The rados pool name. - Default is rbd. - More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it - +optional - - -.. _api_field_k8s.io.api.core.v1.RBDVolumeSource.user: - -user - (`string `_) The rados user name. - Default is admin. - More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it - +optional - - -.. _api_field_k8s.io.api.core.v1.RBDVolumeSource.keyring: - -keyring - (`string `_) Keyring is the path to key ring for RBDUser. - Default is /etc/ceph/keyring. - More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it - +optional - - -.. _api_field_k8s.io.api.core.v1.RBDVolumeSource.secretRef: - -secretRef - (:ref:`k8s.io.api.core.v1.LocalObjectReference `) SecretRef is name of the authentication secret for RBDUser. If provided - overrides keyring. - Default is nil. - More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it - +optional - - -.. _api_field_k8s.io.api.core.v1.RBDVolumeSource.readOnly: - -readOnly - (`bool `_) ReadOnly here will force the ReadOnly setting in VolumeMounts. - Defaults to false. - More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md#how-to-use-it - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.RangeAllocation: - -k8s.io.api.core.v1.RangeAllocation ----------------------------------- - -`[k8s.io.api.core.v1.RangeAllocation proto] `_ - -RangeAllocation is not a public type. - -.. code-block:: json - - { - "metadata": "{...}", - "range": "...", - "data": "..." - } - -.. _api_field_k8s.io.api.core.v1.RangeAllocation.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.RangeAllocation.range: - -range - (`string `_) Range is string that identifies the range represented by 'data'. - - -.. _api_field_k8s.io.api.core.v1.RangeAllocation.data: - -data - (`bytes `_) Data is a bit array containing all allocated addresses in the previous segment. - - - - -.. _api_msg_k8s.io.api.core.v1.ReplicationController: - -k8s.io.api.core.v1.ReplicationController ----------------------------------------- - -`[k8s.io.api.core.v1.ReplicationController proto] `_ - -ReplicationController represents the configuration of a replication controller. - -.. code-block:: json - - { - "metadata": "{...}", - "spec": "{...}", - "status": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.ReplicationController.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) If the Labels of a ReplicationController are empty, they are defaulted to - be the same as the Pod(s) that the replication controller manages. - Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.ReplicationController.spec: - -spec - (:ref:`k8s.io.api.core.v1.ReplicationControllerSpec `) Spec defines the specification of the desired behavior of the replication controller. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - +optional - - -.. _api_field_k8s.io.api.core.v1.ReplicationController.status: - -status - (:ref:`k8s.io.api.core.v1.ReplicationControllerStatus `) Status is the most recently observed status of the replication controller. - This data may be out of date by some window of time. - Populated by the system. - Read-only. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ReplicationControllerCondition: - -k8s.io.api.core.v1.ReplicationControllerCondition -------------------------------------------------- - -`[k8s.io.api.core.v1.ReplicationControllerCondition proto] `_ - -ReplicationControllerCondition describes the state of a replication controller at a certain point. - -.. code-block:: json - - { - "type": "...", - "status": "...", - "lastTransitionTime": "{...}", - "reason": "...", - "message": "..." - } - -.. _api_field_k8s.io.api.core.v1.ReplicationControllerCondition.type: - -type - (`string `_) Type of replication controller condition. - - -.. _api_field_k8s.io.api.core.v1.ReplicationControllerCondition.status: - -status - (`string `_) Status of the condition, one of True, False, Unknown. - - -.. _api_field_k8s.io.api.core.v1.ReplicationControllerCondition.lastTransitionTime: - -lastTransitionTime - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) The last time the condition transitioned from one status to another. - +optional - - -.. _api_field_k8s.io.api.core.v1.ReplicationControllerCondition.reason: - -reason - (`string `_) The reason for the condition's last transition. - +optional - - -.. _api_field_k8s.io.api.core.v1.ReplicationControllerCondition.message: - -message - (`string `_) A human readable message indicating details about the transition. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ReplicationControllerList: - -k8s.io.api.core.v1.ReplicationControllerList --------------------------------------------- - -`[k8s.io.api.core.v1.ReplicationControllerList proto] `_ - -ReplicationControllerList is a collection of replication controllers. - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.ReplicationControllerList.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.api.core.v1.ReplicationControllerList.items: - -items - (:ref:`k8s.io.api.core.v1.ReplicationController `) List of replication controllers. - More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller - - - - -.. _api_msg_k8s.io.api.core.v1.ReplicationControllerSpec: - -k8s.io.api.core.v1.ReplicationControllerSpec --------------------------------------------- - -`[k8s.io.api.core.v1.ReplicationControllerSpec proto] `_ - -ReplicationControllerSpec is the specification of a replication controller. - -.. code-block:: json - - { - "replicas": "...", - "minReadySeconds": "...", - "selector": "{...}", - "template": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.ReplicationControllerSpec.replicas: - -replicas - (`int32 `_) Replicas is the number of desired replicas. - This is a pointer to distinguish between explicit zero and unspecified. - Defaults to 1. - More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller - +optional - - -.. _api_field_k8s.io.api.core.v1.ReplicationControllerSpec.minReadySeconds: - -minReadySeconds - (`int32 `_) Minimum number of seconds for which a newly created pod should be ready - without any of its container crashing, for it to be considered available. - Defaults to 0 (pod will be considered available as soon as it is ready) - +optional - - -.. _api_field_k8s.io.api.core.v1.ReplicationControllerSpec.selector: - -selector - (map<`string `_, `string `_>) Selector is a label query over pods that should match the Replicas count. - If Selector is empty, it is defaulted to the labels present on the Pod template. - Label keys and values that must match in order to be controlled by this replication - controller, if empty defaulted to labels on Pod template. - More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors - +optional - - -.. _api_field_k8s.io.api.core.v1.ReplicationControllerSpec.template: - -template - (:ref:`k8s.io.api.core.v1.PodTemplateSpec `) Template is the object that describes the pod that will be created if - insufficient replicas are detected. This takes precedence over a TemplateRef. - More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#pod-template - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ReplicationControllerStatus: - -k8s.io.api.core.v1.ReplicationControllerStatus ----------------------------------------------- - -`[k8s.io.api.core.v1.ReplicationControllerStatus proto] `_ - -ReplicationControllerStatus represents the current status of a replication -controller. - -.. code-block:: json - - { - "replicas": "...", - "fullyLabeledReplicas": "...", - "readyReplicas": "...", - "availableReplicas": "...", - "observedGeneration": "...", - "conditions": [] - } - -.. _api_field_k8s.io.api.core.v1.ReplicationControllerStatus.replicas: - -replicas - (`int32 `_) Replicas is the most recently oberved number of replicas. - More info: https://kubernetes.io/docs/concepts/workloads/controllers/replicationcontroller#what-is-a-replicationcontroller - - -.. _api_field_k8s.io.api.core.v1.ReplicationControllerStatus.fullyLabeledReplicas: - -fullyLabeledReplicas - (`int32 `_) The number of pods that have labels matching the labels of the pod template of the replication controller. - +optional - - -.. _api_field_k8s.io.api.core.v1.ReplicationControllerStatus.readyReplicas: - -readyReplicas - (`int32 `_) The number of ready replicas for this replication controller. - +optional - - -.. _api_field_k8s.io.api.core.v1.ReplicationControllerStatus.availableReplicas: - -availableReplicas - (`int32 `_) The number of available replicas (ready for at least minReadySeconds) for this replication controller. - +optional - - -.. _api_field_k8s.io.api.core.v1.ReplicationControllerStatus.observedGeneration: - -observedGeneration - (`int64 `_) ObservedGeneration reflects the generation of the most recently observed replication controller. - +optional - - -.. _api_field_k8s.io.api.core.v1.ReplicationControllerStatus.conditions: - -conditions - (:ref:`k8s.io.api.core.v1.ReplicationControllerCondition `) Represents the latest available observations of a replication controller's current state. - +optional - +patchMergeKey=type - +patchStrategy=merge - - - - -.. _api_msg_k8s.io.api.core.v1.ResourceFieldSelector: - -k8s.io.api.core.v1.ResourceFieldSelector ----------------------------------------- - -`[k8s.io.api.core.v1.ResourceFieldSelector proto] `_ - -ResourceFieldSelector represents container resources (cpu, memory) and their output format - -.. code-block:: json - - { - "containerName": "...", - "resource": "...", - "divisor": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.ResourceFieldSelector.containerName: - -containerName - (`string `_) Container name: required for volumes, optional for env vars - +optional - - -.. _api_field_k8s.io.api.core.v1.ResourceFieldSelector.resource: - -resource - (`string `_) Required: resource to select - - -.. _api_field_k8s.io.api.core.v1.ResourceFieldSelector.divisor: - -divisor - (:ref:`k8s.io.apimachinery.pkg.api.resource.Quantity `) Specifies the output format of the exposed resources, defaults to "1" - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ResourceQuota: - -k8s.io.api.core.v1.ResourceQuota --------------------------------- - -`[k8s.io.api.core.v1.ResourceQuota proto] `_ - -ResourceQuota sets aggregate quota restrictions enforced per namespace - -.. code-block:: json - - { - "metadata": "{...}", - "spec": "{...}", - "status": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.ResourceQuota.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.ResourceQuota.spec: - -spec - (:ref:`k8s.io.api.core.v1.ResourceQuotaSpec `) Spec defines the desired quota. - https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - +optional - - -.. _api_field_k8s.io.api.core.v1.ResourceQuota.status: - -status - (:ref:`k8s.io.api.core.v1.ResourceQuotaStatus `) Status defines the actual enforced quota and its current usage. - https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ResourceQuotaList: - -k8s.io.api.core.v1.ResourceQuotaList ------------------------------------- - -`[k8s.io.api.core.v1.ResourceQuotaList proto] `_ - -ResourceQuotaList is a list of ResourceQuota items. - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.ResourceQuotaList.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.api.core.v1.ResourceQuotaList.items: - -items - (:ref:`k8s.io.api.core.v1.ResourceQuota `) Items is a list of ResourceQuota objects. - More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ - - - - -.. _api_msg_k8s.io.api.core.v1.ResourceQuotaSpec: - -k8s.io.api.core.v1.ResourceQuotaSpec ------------------------------------- - -`[k8s.io.api.core.v1.ResourceQuotaSpec proto] `_ - -ResourceQuotaSpec defines the desired hard limits to enforce for Quota. - -.. code-block:: json - - { - "hard": "{...}", - "scopes": [], - "scopeSelector": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.ResourceQuotaSpec.hard: - -hard - (map<`string `_, :ref:`k8s.io.apimachinery.pkg.api.resource.Quantity `>) hard is the set of desired hard limits for each named resource. - More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ - +optional - - -.. _api_field_k8s.io.api.core.v1.ResourceQuotaSpec.scopes: - -scopes - (`string `_) A collection of filters that must match each object tracked by a quota. - If not specified, the quota matches all objects. - +optional - - -.. _api_field_k8s.io.api.core.v1.ResourceQuotaSpec.scopeSelector: - -scopeSelector - (:ref:`k8s.io.api.core.v1.ScopeSelector `) scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota - but expressed using ScopeSelectorOperator in combination with possible values. - For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ResourceQuotaStatus: - -k8s.io.api.core.v1.ResourceQuotaStatus --------------------------------------- - -`[k8s.io.api.core.v1.ResourceQuotaStatus proto] `_ - -ResourceQuotaStatus defines the enforced hard limits and observed use. - -.. code-block:: json - - { - "hard": "{...}", - "used": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.ResourceQuotaStatus.hard: - -hard - (map<`string `_, :ref:`k8s.io.apimachinery.pkg.api.resource.Quantity `>) Hard is the set of enforced hard limits for each named resource. - More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/ - +optional - - -.. _api_field_k8s.io.api.core.v1.ResourceQuotaStatus.used: - -used - (map<`string `_, :ref:`k8s.io.apimachinery.pkg.api.resource.Quantity `>) Used is the current observed total usage of the resource in the namespace. - +optional - - - - - -.. _api_msg_k8s.io.api.core.v1.ResourceRequirements: - -k8s.io.api.core.v1.ResourceRequirements ---------------------------------------- - -`[k8s.io.api.core.v1.ResourceRequirements proto] `_ - -ResourceRequirements describes the compute resource requirements. - -.. code-block:: json - - { - "limits": "{...}", - "requests": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.ResourceRequirements.limits: - -limits - (map<`string `_, :ref:`k8s.io.apimachinery.pkg.api.resource.Quantity `>) Limits describes the maximum amount of compute resources allowed. - More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ - +optional - - -.. _api_field_k8s.io.api.core.v1.ResourceRequirements.requests: - -requests - (map<`string `_, :ref:`k8s.io.apimachinery.pkg.api.resource.Quantity `>) Requests describes the minimum amount of compute resources required. - If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, - otherwise to an implementation-defined value. - More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ - +optional - - - - - -.. _api_msg_k8s.io.api.core.v1.SELinuxOptions: - -k8s.io.api.core.v1.SELinuxOptions ---------------------------------- - -`[k8s.io.api.core.v1.SELinuxOptions proto] `_ - -SELinuxOptions are the labels to be applied to the container - -.. code-block:: json - - { - "user": "...", - "role": "...", - "type": "...", - "level": "..." - } - -.. _api_field_k8s.io.api.core.v1.SELinuxOptions.user: - -user - (`string `_) User is a SELinux user label that applies to the container. - +optional - - -.. _api_field_k8s.io.api.core.v1.SELinuxOptions.role: - -role - (`string `_) Role is a SELinux role label that applies to the container. - +optional - - -.. _api_field_k8s.io.api.core.v1.SELinuxOptions.type: - -type - (`string `_) Type is a SELinux type label that applies to the container. - +optional - - -.. _api_field_k8s.io.api.core.v1.SELinuxOptions.level: - -level - (`string `_) Level is SELinux level label that applies to the container. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ScaleIOPersistentVolumeSource: - -k8s.io.api.core.v1.ScaleIOPersistentVolumeSource ------------------------------------------------- - -`[k8s.io.api.core.v1.ScaleIOPersistentVolumeSource proto] `_ - -ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume - -.. code-block:: json - - { - "gateway": "...", - "system": "...", - "secretRef": "{...}", - "sslEnabled": "...", - "protectionDomain": "...", - "storagePool": "...", - "storageMode": "...", - "volumeName": "...", - "fsType": "...", - "readOnly": "..." - } - -.. _api_field_k8s.io.api.core.v1.ScaleIOPersistentVolumeSource.gateway: - -gateway - (`string `_) The host address of the ScaleIO API Gateway. - - -.. _api_field_k8s.io.api.core.v1.ScaleIOPersistentVolumeSource.system: - -system - (`string `_) The name of the storage system as configured in ScaleIO. - - -.. _api_field_k8s.io.api.core.v1.ScaleIOPersistentVolumeSource.secretRef: - -secretRef - (:ref:`k8s.io.api.core.v1.SecretReference `) SecretRef references to the secret for ScaleIO user and other - sensitive information. If this is not provided, Login operation will fail. - - -.. _api_field_k8s.io.api.core.v1.ScaleIOPersistentVolumeSource.sslEnabled: - -sslEnabled - (`bool `_) Flag to enable/disable SSL communication with Gateway, default false - +optional - - -.. _api_field_k8s.io.api.core.v1.ScaleIOPersistentVolumeSource.protectionDomain: - -protectionDomain - (`string `_) The name of the ScaleIO Protection Domain for the configured storage. - +optional - - -.. _api_field_k8s.io.api.core.v1.ScaleIOPersistentVolumeSource.storagePool: - -storagePool - (`string `_) The ScaleIO Storage Pool associated with the protection domain. - +optional - - -.. _api_field_k8s.io.api.core.v1.ScaleIOPersistentVolumeSource.storageMode: - -storageMode - (`string `_) Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. - Default is ThinProvisioned. - +optional - - -.. _api_field_k8s.io.api.core.v1.ScaleIOPersistentVolumeSource.volumeName: - -volumeName - (`string `_) The name of a volume already created in the ScaleIO system - that is associated with this volume source. - - -.. _api_field_k8s.io.api.core.v1.ScaleIOPersistentVolumeSource.fsType: - -fsType - (`string `_) Filesystem type to mount. - Must be a filesystem type supported by the host operating system. - Ex. "ext4", "xfs", "ntfs". - Default is "xfs" - +optional - - -.. _api_field_k8s.io.api.core.v1.ScaleIOPersistentVolumeSource.readOnly: - -readOnly - (`bool `_) Defaults to false (read/write). ReadOnly here will force - the ReadOnly setting in VolumeMounts. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ScaleIOVolumeSource: - -k8s.io.api.core.v1.ScaleIOVolumeSource --------------------------------------- - -`[k8s.io.api.core.v1.ScaleIOVolumeSource proto] `_ - -ScaleIOVolumeSource represents a persistent ScaleIO volume - -.. code-block:: json - - { - "gateway": "...", - "system": "...", - "secretRef": "{...}", - "sslEnabled": "...", - "protectionDomain": "...", - "storagePool": "...", - "storageMode": "...", - "volumeName": "...", - "fsType": "...", - "readOnly": "..." - } - -.. _api_field_k8s.io.api.core.v1.ScaleIOVolumeSource.gateway: - -gateway - (`string `_) The host address of the ScaleIO API Gateway. - - -.. _api_field_k8s.io.api.core.v1.ScaleIOVolumeSource.system: - -system - (`string `_) The name of the storage system as configured in ScaleIO. - - -.. _api_field_k8s.io.api.core.v1.ScaleIOVolumeSource.secretRef: - -secretRef - (:ref:`k8s.io.api.core.v1.LocalObjectReference `) SecretRef references to the secret for ScaleIO user and other - sensitive information. If this is not provided, Login operation will fail. - - -.. _api_field_k8s.io.api.core.v1.ScaleIOVolumeSource.sslEnabled: - -sslEnabled - (`bool `_) Flag to enable/disable SSL communication with Gateway, default false - +optional - - -.. _api_field_k8s.io.api.core.v1.ScaleIOVolumeSource.protectionDomain: - -protectionDomain - (`string `_) The name of the ScaleIO Protection Domain for the configured storage. - +optional - - -.. _api_field_k8s.io.api.core.v1.ScaleIOVolumeSource.storagePool: - -storagePool - (`string `_) The ScaleIO Storage Pool associated with the protection domain. - +optional - - -.. _api_field_k8s.io.api.core.v1.ScaleIOVolumeSource.storageMode: - -storageMode - (`string `_) Indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. - Default is ThinProvisioned. - +optional - - -.. _api_field_k8s.io.api.core.v1.ScaleIOVolumeSource.volumeName: - -volumeName - (`string `_) The name of a volume already created in the ScaleIO system - that is associated with this volume source. - - -.. _api_field_k8s.io.api.core.v1.ScaleIOVolumeSource.fsType: - -fsType - (`string `_) Filesystem type to mount. - Must be a filesystem type supported by the host operating system. - Ex. "ext4", "xfs", "ntfs". - Default is "xfs". - +optional - - -.. _api_field_k8s.io.api.core.v1.ScaleIOVolumeSource.readOnly: - -readOnly - (`bool `_) Defaults to false (read/write). ReadOnly here will force - the ReadOnly setting in VolumeMounts. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ScopeSelector: - -k8s.io.api.core.v1.ScopeSelector --------------------------------- - -`[k8s.io.api.core.v1.ScopeSelector proto] `_ - -A scope selector represents the AND of the selectors represented -by the scoped-resource selector requirements. - -.. code-block:: json - - { - "matchExpressions": [] - } - -.. _api_field_k8s.io.api.core.v1.ScopeSelector.matchExpressions: - -matchExpressions - (:ref:`k8s.io.api.core.v1.ScopedResourceSelectorRequirement `) A list of scope selector requirements by scope of the resources. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ScopedResourceSelectorRequirement: - -k8s.io.api.core.v1.ScopedResourceSelectorRequirement ----------------------------------------------------- - -`[k8s.io.api.core.v1.ScopedResourceSelectorRequirement proto] `_ - -A scoped-resource selector requirement is a selector that contains values, a scope name, and an operator -that relates the scope name and values. - -.. code-block:: json - - { - "scopeName": "...", - "operator": "...", - "values": [] - } - -.. _api_field_k8s.io.api.core.v1.ScopedResourceSelectorRequirement.scopeName: - -scopeName - (`string `_) The name of the scope that the selector applies to. - - -.. _api_field_k8s.io.api.core.v1.ScopedResourceSelectorRequirement.operator: - -operator - (`string `_) Represents a scope's relationship to a set of values. - Valid operators are In, NotIn, Exists, DoesNotExist. - - -.. _api_field_k8s.io.api.core.v1.ScopedResourceSelectorRequirement.values: - -values - (`string `_) An array of string values. If the operator is In or NotIn, - the values array must be non-empty. If the operator is Exists or DoesNotExist, - the values array must be empty. - This array is replaced during a strategic merge patch. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.Secret: - -k8s.io.api.core.v1.Secret -------------------------- - -`[k8s.io.api.core.v1.Secret proto] `_ - -Secret holds secret data of a certain type. The total bytes of the values in -the Data field must be less than MaxSecretSize bytes. - -.. code-block:: json - - { - "metadata": "{...}", - "data": "{...}", - "stringData": "{...}", - "type": "..." - } - -.. _api_field_k8s.io.api.core.v1.Secret.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.Secret.data: - -data - (map<`string `_, `bytes `_>) Data contains the secret data. Each key must consist of alphanumeric - characters, '-', '_' or '.'. The serialized form of the secret data is a - base64 encoded string, representing the arbitrary (possibly non-string) - data value here. Described in https://tools.ietf.org/html/rfc4648#section-4 - +optional - - -.. _api_field_k8s.io.api.core.v1.Secret.stringData: - -stringData - (map<`string `_, `string `_>) stringData allows specifying non-binary secret data in string form. - It is provided as a write-only convenience method. - All keys and values are merged into the data field on write, overwriting any existing values. - It is never output when reading from the API. - +k8s:conversion-gen=false - +optional - - -.. _api_field_k8s.io.api.core.v1.Secret.type: - -type - (`string `_) Used to facilitate programmatic handling of secret data. - +optional - - - - - -.. _api_msg_k8s.io.api.core.v1.SecretEnvSource: - -k8s.io.api.core.v1.SecretEnvSource ----------------------------------- - -`[k8s.io.api.core.v1.SecretEnvSource proto] `_ - -SecretEnvSource selects a Secret to populate the environment -variables with. - -The contents of the target Secret's Data field will represent the -key-value pairs as environment variables. - -.. code-block:: json - - { - "localObjectReference": "{...}", - "optional": "..." - } - -.. _api_field_k8s.io.api.core.v1.SecretEnvSource.localObjectReference: - -localObjectReference - (:ref:`k8s.io.api.core.v1.LocalObjectReference `) The Secret to select from. - - -.. _api_field_k8s.io.api.core.v1.SecretEnvSource.optional: - -optional - (`bool `_) Specify whether the Secret must be defined - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.SecretKeySelector: - -k8s.io.api.core.v1.SecretKeySelector ------------------------------------- - -`[k8s.io.api.core.v1.SecretKeySelector proto] `_ - -SecretKeySelector selects a key of a Secret. - -.. code-block:: json - - { - "localObjectReference": "{...}", - "key": "...", - "optional": "..." - } - -.. _api_field_k8s.io.api.core.v1.SecretKeySelector.localObjectReference: - -localObjectReference - (:ref:`k8s.io.api.core.v1.LocalObjectReference `) The name of the secret in the pod's namespace to select from. - - -.. _api_field_k8s.io.api.core.v1.SecretKeySelector.key: - -key - (`string `_) The key of the secret to select from. Must be a valid secret key. - - -.. _api_field_k8s.io.api.core.v1.SecretKeySelector.optional: - -optional - (`bool `_) Specify whether the Secret or it's key must be defined - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.SecretList: - -k8s.io.api.core.v1.SecretList ------------------------------ - -`[k8s.io.api.core.v1.SecretList proto] `_ - -SecretList is a list of Secret. - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.SecretList.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.api.core.v1.SecretList.items: - -items - (:ref:`k8s.io.api.core.v1.Secret `) Items is a list of secret objects. - More info: https://kubernetes.io/docs/concepts/configuration/secret - - - - -.. _api_msg_k8s.io.api.core.v1.SecretProjection: - -k8s.io.api.core.v1.SecretProjection ------------------------------------ - -`[k8s.io.api.core.v1.SecretProjection proto] `_ - -Adapts a secret into a projected volume. - -The contents of the target Secret's Data field will be presented in a -projected volume as files using the keys in the Data field as the file names. -Note that this is identical to a secret volume source without the default -mode. - -.. code-block:: json - - { - "localObjectReference": "{...}", - "items": [], - "optional": "..." - } - -.. _api_field_k8s.io.api.core.v1.SecretProjection.localObjectReference: - -localObjectReference - (:ref:`k8s.io.api.core.v1.LocalObjectReference `) - -.. _api_field_k8s.io.api.core.v1.SecretProjection.items: - -items - (:ref:`k8s.io.api.core.v1.KeyToPath `) If unspecified, each key-value pair in the Data field of the referenced - Secret will be projected into the volume as a file whose name is the - key and content is the value. If specified, the listed keys will be - projected into the specified paths, and unlisted keys will not be - present. If a key is specified which is not present in the Secret, - the volume setup will error unless it is marked optional. Paths must be - relative and may not contain the '..' path or start with '..'. - +optional - - -.. _api_field_k8s.io.api.core.v1.SecretProjection.optional: - -optional - (`bool `_) Specify whether the Secret or its key must be defined - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.SecretReference: - -k8s.io.api.core.v1.SecretReference ----------------------------------- - -`[k8s.io.api.core.v1.SecretReference proto] `_ - -SecretReference represents a Secret Reference. It has enough information to retrieve secret -in any namespace - -.. code-block:: json - - { - "name": "...", - "namespace": "..." - } - -.. _api_field_k8s.io.api.core.v1.SecretReference.name: - -name - (`string `_) Name is unique within a namespace to reference a secret resource. - +optional - - -.. _api_field_k8s.io.api.core.v1.SecretReference.namespace: - -namespace - (`string `_) Namespace defines the space within which the secret name must be unique. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.SecretVolumeSource: - -k8s.io.api.core.v1.SecretVolumeSource -------------------------------------- - -`[k8s.io.api.core.v1.SecretVolumeSource proto] `_ - -Adapts a Secret into a volume. - -The contents of the target Secret's Data field will be presented in a volume -as files using the keys in the Data field as the file names. -Secret volumes support ownership management and SELinux relabeling. - -.. code-block:: json - - { - "secretName": "...", - "items": [], - "defaultMode": "...", - "optional": "..." - } - -.. _api_field_k8s.io.api.core.v1.SecretVolumeSource.secretName: - -secretName - (`string `_) Name of the secret in the pod's namespace to use. - More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - +optional - - -.. _api_field_k8s.io.api.core.v1.SecretVolumeSource.items: - -items - (:ref:`k8s.io.api.core.v1.KeyToPath `) If unspecified, each key-value pair in the Data field of the referenced - Secret will be projected into the volume as a file whose name is the - key and content is the value. If specified, the listed keys will be - projected into the specified paths, and unlisted keys will not be - present. If a key is specified which is not present in the Secret, - the volume setup will error unless it is marked optional. Paths must be - relative and may not contain the '..' path or start with '..'. - +optional - - -.. _api_field_k8s.io.api.core.v1.SecretVolumeSource.defaultMode: - -defaultMode - (`int32 `_) Optional: mode bits to use on created files by default. Must be a - value between 0 and 0777. Defaults to 0644. - Directories within the path are not affected by this setting. - This might be in conflict with other options that affect the file - mode, like fsGroup, and the result can be other mode bits set. - +optional - - -.. _api_field_k8s.io.api.core.v1.SecretVolumeSource.optional: - -optional - (`bool `_) Specify whether the Secret or it's keys must be defined - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.SecurityContext: - -k8s.io.api.core.v1.SecurityContext ----------------------------------- - -`[k8s.io.api.core.v1.SecurityContext proto] `_ - -SecurityContext holds security configuration that will be applied to a container. -Some fields are present in both SecurityContext and PodSecurityContext. When both -are set, the values in SecurityContext take precedence. - -.. code-block:: json - - { - "capabilities": "{...}", - "privileged": "...", - "seLinuxOptions": "{...}", - "runAsUser": "...", - "runAsGroup": "...", - "runAsNonRoot": "...", - "readOnlyRootFilesystem": "...", - "allowPrivilegeEscalation": "...", - "procMount": "..." - } - -.. _api_field_k8s.io.api.core.v1.SecurityContext.capabilities: - -capabilities - (:ref:`k8s.io.api.core.v1.Capabilities `) The capabilities to add/drop when running containers. - Defaults to the default set of capabilities granted by the container runtime. - +optional - - -.. _api_field_k8s.io.api.core.v1.SecurityContext.privileged: - -privileged - (`bool `_) Run container in privileged mode. - Processes in privileged containers are essentially equivalent to root on the host. - Defaults to false. - +optional - - -.. _api_field_k8s.io.api.core.v1.SecurityContext.seLinuxOptions: - -seLinuxOptions - (:ref:`k8s.io.api.core.v1.SELinuxOptions `) The SELinux context to be applied to the container. - If unspecified, the container runtime will allocate a random SELinux context for each - container. May also be set in PodSecurityContext. If set in both SecurityContext and - PodSecurityContext, the value specified in SecurityContext takes precedence. - +optional - - -.. _api_field_k8s.io.api.core.v1.SecurityContext.runAsUser: - -runAsUser - (`int64 `_) The UID to run the entrypoint of the container process. - Defaults to user specified in image metadata if unspecified. - May also be set in PodSecurityContext. If set in both SecurityContext and - PodSecurityContext, the value specified in SecurityContext takes precedence. - +optional - - -.. _api_field_k8s.io.api.core.v1.SecurityContext.runAsGroup: - -runAsGroup - (`int64 `_) The GID to run the entrypoint of the container process. - Uses runtime default if unset. - May also be set in PodSecurityContext. If set in both SecurityContext and - PodSecurityContext, the value specified in SecurityContext takes precedence. - +optional - - -.. _api_field_k8s.io.api.core.v1.SecurityContext.runAsNonRoot: - -runAsNonRoot - (`bool `_) Indicates that the container must run as a non-root user. - If true, the Kubelet will validate the image at runtime to ensure that it - does not run as UID 0 (root) and fail to start the container if it does. - If unset or false, no such validation will be performed. - May also be set in PodSecurityContext. If set in both SecurityContext and - PodSecurityContext, the value specified in SecurityContext takes precedence. - +optional - - -.. _api_field_k8s.io.api.core.v1.SecurityContext.readOnlyRootFilesystem: - -readOnlyRootFilesystem - (`bool `_) Whether this container has a read-only root filesystem. - Default is false. - +optional - - -.. _api_field_k8s.io.api.core.v1.SecurityContext.allowPrivilegeEscalation: - -allowPrivilegeEscalation - (`bool `_) AllowPrivilegeEscalation controls whether a process can gain more - privileges than its parent process. This bool directly controls if - the no_new_privs flag will be set on the container process. - AllowPrivilegeEscalation is true always when the container is: - 1) run as Privileged - 2) has CAP_SYS_ADMIN - +optional - - -.. _api_field_k8s.io.api.core.v1.SecurityContext.procMount: - -procMount - (`string `_) procMount denotes the type of proc mount to use for the containers. - The default is DefaultProcMount which uses the container runtime defaults for - readonly paths and masked paths. - This requires the ProcMountType feature flag to be enabled. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.SerializedReference: - -k8s.io.api.core.v1.SerializedReference --------------------------------------- - -`[k8s.io.api.core.v1.SerializedReference proto] `_ - -SerializedReference is a reference to serialized object. - -.. code-block:: json - - { - "reference": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.SerializedReference.reference: - -reference - (:ref:`k8s.io.api.core.v1.ObjectReference `) The reference to an object in the system. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.Service: - -k8s.io.api.core.v1.Service --------------------------- - -`[k8s.io.api.core.v1.Service proto] `_ - -Service is a named abstraction of software service (for example, mysql) consisting of local port -(for example 3306) that the proxy listens on, and the selector that determines which pods -will answer requests sent through the proxy. - -.. code-block:: json - - { - "metadata": "{...}", - "spec": "{...}", - "status": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.Service.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.Service.spec: - -spec - (:ref:`k8s.io.api.core.v1.ServiceSpec `) Spec defines the behavior of a service. - https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - +optional - - -.. _api_field_k8s.io.api.core.v1.Service.status: - -status - (:ref:`k8s.io.api.core.v1.ServiceStatus `) Most recently observed status of the service. - Populated by the system. - Read-only. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ServiceAccount: - -k8s.io.api.core.v1.ServiceAccount ---------------------------------- - -`[k8s.io.api.core.v1.ServiceAccount proto] `_ - -ServiceAccount binds together: -* a name, understood by users, and perhaps by peripheral systems, for an identity -* a principal that can be authenticated and authorized -* a set of secrets - -.. code-block:: json - - { - "metadata": "{...}", - "secrets": [], - "imagePullSecrets": [], - "automountServiceAccountToken": "..." - } - -.. _api_field_k8s.io.api.core.v1.ServiceAccount.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta `) Standard object's metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.api.core.v1.ServiceAccount.secrets: - -secrets - (:ref:`k8s.io.api.core.v1.ObjectReference `) Secrets is the list of secrets allowed to be used by pods running using this ServiceAccount. - More info: https://kubernetes.io/docs/concepts/configuration/secret - +optional - +patchMergeKey=name - +patchStrategy=merge - - -.. _api_field_k8s.io.api.core.v1.ServiceAccount.imagePullSecrets: - -imagePullSecrets - (:ref:`k8s.io.api.core.v1.LocalObjectReference `) ImagePullSecrets is a list of references to secrets in the same namespace to use for pulling any images - in pods that reference this ServiceAccount. ImagePullSecrets are distinct from Secrets because Secrets - can be mounted in the pod, but ImagePullSecrets are only accessed by the kubelet. - More info: https://kubernetes.io/docs/concepts/containers/images/#specifying-imagepullsecrets-on-a-pod - +optional - - -.. _api_field_k8s.io.api.core.v1.ServiceAccount.automountServiceAccountToken: - -automountServiceAccountToken - (`bool `_) AutomountServiceAccountToken indicates whether pods running as this service account should have an API token automatically mounted. - Can be overridden at the pod level. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ServiceAccountList: - -k8s.io.api.core.v1.ServiceAccountList -------------------------------------- - -`[k8s.io.api.core.v1.ServiceAccountList proto] `_ - -ServiceAccountList is a list of ServiceAccount objects - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.ServiceAccountList.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.api.core.v1.ServiceAccountList.items: - -items - (:ref:`k8s.io.api.core.v1.ServiceAccount `) List of ServiceAccounts. - More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ - - - - -.. _api_msg_k8s.io.api.core.v1.ServiceAccountTokenProjection: - -k8s.io.api.core.v1.ServiceAccountTokenProjection ------------------------------------------------- - -`[k8s.io.api.core.v1.ServiceAccountTokenProjection proto] `_ - -ServiceAccountTokenProjection represents a projected service account token -volume. This projection can be used to insert a service account token into -the pods runtime filesystem for use against APIs (Kubernetes API Server or -otherwise). - -.. code-block:: json - - { - "audience": "...", - "expirationSeconds": "...", - "path": "..." - } - -.. _api_field_k8s.io.api.core.v1.ServiceAccountTokenProjection.audience: - -audience - (`string `_) Audience is the intended audience of the token. A recipient of a token - must identify itself with an identifier specified in the audience of the - token, and otherwise should reject the token. The audience defaults to the - identifier of the apiserver. - +optional - - -.. _api_field_k8s.io.api.core.v1.ServiceAccountTokenProjection.expirationSeconds: - -expirationSeconds - (`int64 `_) ExpirationSeconds is the requested duration of validity of the service - account token. As the token approaches expiration, the kubelet volume - plugin will proactively rotate the service account token. The kubelet will - start trying to rotate the token if the token is older than 80 percent of - its time to live or if the token is older than 24 hours.Defaults to 1 hour - and must be at least 10 minutes. - +optional - - -.. _api_field_k8s.io.api.core.v1.ServiceAccountTokenProjection.path: - -path - (`string `_) Path is the path relative to the mount point of the file to project the - token into. - - - - -.. _api_msg_k8s.io.api.core.v1.ServiceList: - -k8s.io.api.core.v1.ServiceList ------------------------------- - -`[k8s.io.api.core.v1.ServiceList proto] `_ - -ServiceList holds a list of services. - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.api.core.v1.ServiceList.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.api.core.v1.ServiceList.items: - -items - (:ref:`k8s.io.api.core.v1.Service `) List of services - - - - -.. _api_msg_k8s.io.api.core.v1.ServicePort: - -k8s.io.api.core.v1.ServicePort ------------------------------- - -`[k8s.io.api.core.v1.ServicePort proto] `_ - -ServicePort contains information on service's port. - -.. code-block:: json - - { - "name": "...", - "protocol": "...", - "port": "...", - "targetPort": "{...}", - "nodePort": "..." - } - -.. _api_field_k8s.io.api.core.v1.ServicePort.name: - -name - (`string `_) The name of this port within the service. This must be a DNS_LABEL. - All ports within a ServiceSpec must have unique names. This maps to - the 'Name' field in EndpointPort objects. - Optional if only one ServicePort is defined on this service. - +optional - - -.. _api_field_k8s.io.api.core.v1.ServicePort.protocol: - -protocol - (`string `_) The IP protocol for this port. Supports "TCP", "UDP", and "SCTP". - Default is TCP. - +optional - - -.. _api_field_k8s.io.api.core.v1.ServicePort.port: - -port - (`int32 `_) The port that will be exposed by this service. - - -.. _api_field_k8s.io.api.core.v1.ServicePort.targetPort: - -targetPort - (:ref:`k8s.io.apimachinery.pkg.util.intstr.IntOrString `) Number or name of the port to access on the pods targeted by the service. - Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. - If this is a string, it will be looked up as a named port in the - target Pod's container ports. If this is not specified, the value - of the 'port' field is used (an identity map). - This field is ignored for services with clusterIP=None, and should be - omitted or set equal to the 'port' field. - More info: https://kubernetes.io/docs/concepts/services-networking/service/#defining-a-service - +optional - - -.. _api_field_k8s.io.api.core.v1.ServicePort.nodePort: - -nodePort - (`int32 `_) The port on each node on which this service is exposed when type=NodePort or LoadBalancer. - Usually assigned by the system. If specified, it will be allocated to the service - if unused or else creation of the service will fail. - Default is to auto-allocate a port if the ServiceType of this Service requires one. - More info: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ServiceProxyOptions: - -k8s.io.api.core.v1.ServiceProxyOptions --------------------------------------- - -`[k8s.io.api.core.v1.ServiceProxyOptions proto] `_ - -ServiceProxyOptions is the query options to a Service's proxy call. - -.. code-block:: json - - { - "path": "..." - } - -.. _api_field_k8s.io.api.core.v1.ServiceProxyOptions.path: - -path - (`string `_) Path is the part of URLs that include service endpoints, suffixes, - and parameters to use for the current proxy request to service. - For example, the whole request URL is - http://localhost/api/v1/namespaces/kube-system/services/elasticsearch-logging/_search?q=user:kimchy. - Path is _search?q=user:kimchy. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ServiceSpec: - -k8s.io.api.core.v1.ServiceSpec ------------------------------- - -`[k8s.io.api.core.v1.ServiceSpec proto] `_ - -ServiceSpec describes the attributes that a user creates on a service. - -.. code-block:: json - - { - "ports": [], - "selector": "{...}", - "clusterIP": "...", - "type": "...", - "externalIPs": [], - "sessionAffinity": "...", - "loadBalancerIP": "...", - "loadBalancerSourceRanges": [], - "externalName": "...", - "externalTrafficPolicy": "...", - "healthCheckNodePort": "...", - "publishNotReadyAddresses": "...", - "sessionAffinityConfig": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.ServiceSpec.ports: - -ports - (:ref:`k8s.io.api.core.v1.ServicePort `) The list of ports that are exposed by this service. - More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies - +patchMergeKey=port - +patchStrategy=merge - +listType=map - +listMapKey=port - +listMapKey=protocol - - -.. _api_field_k8s.io.api.core.v1.ServiceSpec.selector: - -selector - (map<`string `_, `string `_>) Route service traffic to pods with label keys and values matching this - selector. If empty or not present, the service is assumed to have an - external process managing its endpoints, which Kubernetes will not - modify. Only applies to types ClusterIP, NodePort, and LoadBalancer. - Ignored if type is ExternalName. - More info: https://kubernetes.io/docs/concepts/services-networking/service/ - +optional - - -.. _api_field_k8s.io.api.core.v1.ServiceSpec.clusterIP: - -clusterIP - (`string `_) clusterIP is the IP address of the service and is usually assigned - randomly by the master. If an address is specified manually and is not in - use by others, it will be allocated to the service; otherwise, creation - of the service will fail. This field can not be changed through updates. - Valid values are "None", empty string (""), or a valid IP address. "None" - can be specified for headless services when proxying is not required. - Only applies to types ClusterIP, NodePort, and LoadBalancer. Ignored if - type is ExternalName. - More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies - +optional - - -.. _api_field_k8s.io.api.core.v1.ServiceSpec.type: - -type - (`string `_) type determines how the Service is exposed. Defaults to ClusterIP. Valid - options are ExternalName, ClusterIP, NodePort, and LoadBalancer. - "ExternalName" maps to the specified externalName. - "ClusterIP" allocates a cluster-internal IP address for load-balancing to - endpoints. Endpoints are determined by the selector or if that is not - specified, by manual construction of an Endpoints object. If clusterIP is - "None", no virtual IP is allocated and the endpoints are published as a - set of endpoints rather than a stable IP. - "NodePort" builds on ClusterIP and allocates a port on every node which - routes to the clusterIP. - "LoadBalancer" builds on NodePort and creates an - external load-balancer (if supported in the current cloud) which routes - to the clusterIP. - More info: https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types - +optional - - -.. _api_field_k8s.io.api.core.v1.ServiceSpec.externalIPs: - -externalIPs - (`string `_) externalIPs is a list of IP addresses for which nodes in the cluster - will also accept traffic for this service. These IPs are not managed by - Kubernetes. The user is responsible for ensuring that traffic arrives - at a node with this IP. A common example is external load-balancers - that are not part of the Kubernetes system. - +optional - - -.. _api_field_k8s.io.api.core.v1.ServiceSpec.sessionAffinity: - -sessionAffinity - (`string `_) Supports "ClientIP" and "None". Used to maintain session affinity. - Enable client IP based session affinity. - Must be ClientIP or None. - Defaults to None. - More info: https://kubernetes.io/docs/concepts/services-networking/service/#virtual-ips-and-service-proxies - +optional - - -.. _api_field_k8s.io.api.core.v1.ServiceSpec.loadBalancerIP: - -loadBalancerIP - (`string `_) Only applies to Service Type: LoadBalancer - LoadBalancer will get created with the IP specified in this field. - This feature depends on whether the underlying cloud-provider supports specifying - the loadBalancerIP when a load balancer is created. - This field will be ignored if the cloud-provider does not support the feature. - +optional - - -.. _api_field_k8s.io.api.core.v1.ServiceSpec.loadBalancerSourceRanges: - -loadBalancerSourceRanges - (`string `_) If specified and supported by the platform, this will restrict traffic through the cloud-provider - load-balancer will be restricted to the specified client IPs. This field will be ignored if the - cloud-provider does not support the feature." - More info: https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/ - +optional - - -.. _api_field_k8s.io.api.core.v1.ServiceSpec.externalName: - -externalName - (`string `_) externalName is the external reference that kubedns or equivalent will - return as a CNAME record for this service. No proxying will be involved. - Must be a valid RFC-1123 hostname (https://tools.ietf.org/html/rfc1123) - and requires Type to be ExternalName. - +optional - - -.. _api_field_k8s.io.api.core.v1.ServiceSpec.externalTrafficPolicy: - -externalTrafficPolicy - (`string `_) externalTrafficPolicy denotes if this Service desires to route external - traffic to node-local or cluster-wide endpoints. "Local" preserves the - client source IP and avoids a second hop for LoadBalancer and Nodeport - type services, but risks potentially imbalanced traffic spreading. - "Cluster" obscures the client source IP and may cause a second hop to - another node, but should have good overall load-spreading. - +optional - - -.. _api_field_k8s.io.api.core.v1.ServiceSpec.healthCheckNodePort: - -healthCheckNodePort - (`int32 `_) healthCheckNodePort specifies the healthcheck nodePort for the service. - If not specified, HealthCheckNodePort is created by the service api - backend with the allocated nodePort. Will use user-specified nodePort value - if specified by the client. Only effects when Type is set to LoadBalancer - and ExternalTrafficPolicy is set to Local. - +optional - - -.. _api_field_k8s.io.api.core.v1.ServiceSpec.publishNotReadyAddresses: - -publishNotReadyAddresses - (`bool `_) publishNotReadyAddresses, when set to true, indicates that DNS implementations - must publish the notReadyAddresses of subsets for the Endpoints associated with - the Service. The default value is false. - The primary use case for setting this field is to use a StatefulSet's Headless Service - to propagate SRV records for its Pods without respect to their readiness for purpose - of peer discovery. - +optional - - -.. _api_field_k8s.io.api.core.v1.ServiceSpec.sessionAffinityConfig: - -sessionAffinityConfig - (:ref:`k8s.io.api.core.v1.SessionAffinityConfig `) sessionAffinityConfig contains the configurations of session affinity. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.ServiceStatus: - -k8s.io.api.core.v1.ServiceStatus --------------------------------- - -`[k8s.io.api.core.v1.ServiceStatus proto] `_ - -ServiceStatus represents the current status of a service. - -.. code-block:: json - - { - "loadBalancer": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.ServiceStatus.loadBalancer: - -loadBalancer - (:ref:`k8s.io.api.core.v1.LoadBalancerStatus `) LoadBalancer contains the current status of the load-balancer, - if one is present. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.SessionAffinityConfig: - -k8s.io.api.core.v1.SessionAffinityConfig ----------------------------------------- - -`[k8s.io.api.core.v1.SessionAffinityConfig proto] `_ - -SessionAffinityConfig represents the configurations of session affinity. - -.. code-block:: json - - { - "clientIP": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.SessionAffinityConfig.clientIP: - -clientIP - (:ref:`k8s.io.api.core.v1.ClientIPConfig `) clientIP contains the configurations of Client IP based session affinity. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.StorageOSPersistentVolumeSource: - -k8s.io.api.core.v1.StorageOSPersistentVolumeSource --------------------------------------------------- - -`[k8s.io.api.core.v1.StorageOSPersistentVolumeSource proto] `_ - -Represents a StorageOS persistent volume resource. - -.. code-block:: json - - { - "volumeName": "...", - "volumeNamespace": "...", - "fsType": "...", - "readOnly": "...", - "secretRef": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.StorageOSPersistentVolumeSource.volumeName: - -volumeName - (`string `_) VolumeName is the human-readable name of the StorageOS volume. Volume - names are only unique within a namespace. - - -.. _api_field_k8s.io.api.core.v1.StorageOSPersistentVolumeSource.volumeNamespace: - -volumeNamespace - (`string `_) VolumeNamespace specifies the scope of the volume within StorageOS. If no - namespace is specified then the Pod's namespace will be used. This allows the - Kubernetes name scoping to be mirrored within StorageOS for tighter integration. - Set VolumeName to any name to override the default behaviour. - Set to "default" if you are not using namespaces within StorageOS. - Namespaces that do not pre-exist within StorageOS will be created. - +optional - - -.. _api_field_k8s.io.api.core.v1.StorageOSPersistentVolumeSource.fsType: - -fsType - (`string `_) Filesystem type to mount. - Must be a filesystem type supported by the host operating system. - Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - +optional - - -.. _api_field_k8s.io.api.core.v1.StorageOSPersistentVolumeSource.readOnly: - -readOnly - (`bool `_) Defaults to false (read/write). ReadOnly here will force - the ReadOnly setting in VolumeMounts. - +optional - - -.. _api_field_k8s.io.api.core.v1.StorageOSPersistentVolumeSource.secretRef: - -secretRef - (:ref:`k8s.io.api.core.v1.ObjectReference `) SecretRef specifies the secret to use for obtaining the StorageOS API - credentials. If not specified, default values will be attempted. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.StorageOSVolumeSource: - -k8s.io.api.core.v1.StorageOSVolumeSource ----------------------------------------- - -`[k8s.io.api.core.v1.StorageOSVolumeSource proto] `_ - -Represents a StorageOS persistent volume resource. - -.. code-block:: json - - { - "volumeName": "...", - "volumeNamespace": "...", - "fsType": "...", - "readOnly": "...", - "secretRef": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.StorageOSVolumeSource.volumeName: - -volumeName - (`string `_) VolumeName is the human-readable name of the StorageOS volume. Volume - names are only unique within a namespace. - - -.. _api_field_k8s.io.api.core.v1.StorageOSVolumeSource.volumeNamespace: - -volumeNamespace - (`string `_) VolumeNamespace specifies the scope of the volume within StorageOS. If no - namespace is specified then the Pod's namespace will be used. This allows the - Kubernetes name scoping to be mirrored within StorageOS for tighter integration. - Set VolumeName to any name to override the default behaviour. - Set to "default" if you are not using namespaces within StorageOS. - Namespaces that do not pre-exist within StorageOS will be created. - +optional - - -.. _api_field_k8s.io.api.core.v1.StorageOSVolumeSource.fsType: - -fsType - (`string `_) Filesystem type to mount. - Must be a filesystem type supported by the host operating system. - Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - +optional - - -.. _api_field_k8s.io.api.core.v1.StorageOSVolumeSource.readOnly: - -readOnly - (`bool `_) Defaults to false (read/write). ReadOnly here will force - the ReadOnly setting in VolumeMounts. - +optional - - -.. _api_field_k8s.io.api.core.v1.StorageOSVolumeSource.secretRef: - -secretRef - (:ref:`k8s.io.api.core.v1.LocalObjectReference `) SecretRef specifies the secret to use for obtaining the StorageOS API - credentials. If not specified, default values will be attempted. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.Sysctl: - -k8s.io.api.core.v1.Sysctl -------------------------- - -`[k8s.io.api.core.v1.Sysctl proto] `_ - -Sysctl defines a kernel parameter to be set - -.. code-block:: json - - { - "name": "...", - "value": "..." - } - -.. _api_field_k8s.io.api.core.v1.Sysctl.name: - -name - (`string `_) Name of a property to set - - -.. _api_field_k8s.io.api.core.v1.Sysctl.value: - -value - (`string `_) Value of a property to set - - - - -.. _api_msg_k8s.io.api.core.v1.TCPSocketAction: - -k8s.io.api.core.v1.TCPSocketAction ----------------------------------- - -`[k8s.io.api.core.v1.TCPSocketAction proto] `_ - -TCPSocketAction describes an action based on opening a socket - -.. code-block:: json - - { - "port": "{...}", - "host": "..." - } - -.. _api_field_k8s.io.api.core.v1.TCPSocketAction.port: - -port - (:ref:`k8s.io.apimachinery.pkg.util.intstr.IntOrString `) Number or name of the port to access on the container. - Number must be in the range 1 to 65535. - Name must be an IANA_SVC_NAME. - - -.. _api_field_k8s.io.api.core.v1.TCPSocketAction.host: - -host - (`string `_) Optional: Host name to connect to, defaults to the pod IP. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.Taint: - -k8s.io.api.core.v1.Taint ------------------------- - -`[k8s.io.api.core.v1.Taint proto] `_ - -The node this Taint is attached to has the "effect" on -any pod that does not tolerate the Taint. - -.. code-block:: json - - { - "key": "...", - "value": "...", - "effect": "...", - "timeAdded": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.Taint.key: - -key - (`string `_) Required. The taint key to be applied to a node. - - -.. _api_field_k8s.io.api.core.v1.Taint.value: - -value - (`string `_) Required. The taint value corresponding to the taint key. - +optional - - -.. _api_field_k8s.io.api.core.v1.Taint.effect: - -effect - (`string `_) Required. The effect of the taint on pods - that do not tolerate the taint. - Valid effects are NoSchedule, PreferNoSchedule and NoExecute. - - -.. _api_field_k8s.io.api.core.v1.Taint.timeAdded: - -timeAdded - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) TimeAdded represents the time at which the taint was added. - It is only written for NoExecute taints. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.Toleration: - -k8s.io.api.core.v1.Toleration ------------------------------ - -`[k8s.io.api.core.v1.Toleration proto] `_ - -The pod this Toleration is attached to tolerates any taint that matches -the triple using the matching operator . - -.. code-block:: json - - { - "key": "...", - "operator": "...", - "value": "...", - "effect": "...", - "tolerationSeconds": "..." - } - -.. _api_field_k8s.io.api.core.v1.Toleration.key: - -key - (`string `_) Key is the taint key that the toleration applies to. Empty means match all taint keys. - If the key is empty, operator must be Exists; this combination means to match all values and all keys. - +optional - - -.. _api_field_k8s.io.api.core.v1.Toleration.operator: - -operator - (`string `_) Operator represents a key's relationship to the value. - Valid operators are Exists and Equal. Defaults to Equal. - Exists is equivalent to wildcard for value, so that a pod can - tolerate all taints of a particular category. - +optional - - -.. _api_field_k8s.io.api.core.v1.Toleration.value: - -value - (`string `_) Value is the taint value the toleration matches to. - If the operator is Exists, the value should be empty, otherwise just a regular string. - +optional - - -.. _api_field_k8s.io.api.core.v1.Toleration.effect: - -effect - (`string `_) Effect indicates the taint effect to match. Empty means match all taint effects. - When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute. - +optional - - -.. _api_field_k8s.io.api.core.v1.Toleration.tolerationSeconds: - -tolerationSeconds - (`int64 `_) TolerationSeconds represents the period of time the toleration (which must be - of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, - it is not set, which means tolerate the taint forever (do not evict). Zero and - negative values will be treated as 0 (evict immediately) by the system. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.TopologySelectorLabelRequirement: - -k8s.io.api.core.v1.TopologySelectorLabelRequirement ---------------------------------------------------- - -`[k8s.io.api.core.v1.TopologySelectorLabelRequirement proto] `_ - -A topology selector requirement is a selector that matches given label. -This is an alpha feature and may change in the future. - -.. code-block:: json - - { - "key": "...", - "values": [] - } - -.. _api_field_k8s.io.api.core.v1.TopologySelectorLabelRequirement.key: - -key - (`string `_) The label key that the selector applies to. - - -.. _api_field_k8s.io.api.core.v1.TopologySelectorLabelRequirement.values: - -values - (`string `_) An array of string values. One value must match the label to be selected. - Each entry in Values is ORed. - - - - -.. _api_msg_k8s.io.api.core.v1.TopologySelectorTerm: - -k8s.io.api.core.v1.TopologySelectorTerm ---------------------------------------- - -`[k8s.io.api.core.v1.TopologySelectorTerm proto] `_ - -A topology selector term represents the result of label queries. -A null or empty topology selector term matches no objects. -The requirements of them are ANDed. -It provides a subset of functionality as NodeSelectorTerm. -This is an alpha feature and may change in the future. - -.. code-block:: json - - { - "matchLabelExpressions": [] - } - -.. _api_field_k8s.io.api.core.v1.TopologySelectorTerm.matchLabelExpressions: - -matchLabelExpressions - (:ref:`k8s.io.api.core.v1.TopologySelectorLabelRequirement `) A list of topology selector requirements by labels. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.TypedLocalObjectReference: - -k8s.io.api.core.v1.TypedLocalObjectReference --------------------------------------------- - -`[k8s.io.api.core.v1.TypedLocalObjectReference proto] `_ - -TypedLocalObjectReference contains enough information to let you locate the -typed referenced object inside the same namespace. - -.. code-block:: json - - { - "apiGroup": "...", - "kind": "...", - "name": "..." - } - -.. _api_field_k8s.io.api.core.v1.TypedLocalObjectReference.apiGroup: - -apiGroup - (`string `_) APIGroup is the group for the resource being referenced. - If APIGroup is not specified, the specified Kind must be in the core API group. - For any other third-party types, APIGroup is required. - +optional - - -.. _api_field_k8s.io.api.core.v1.TypedLocalObjectReference.kind: - -kind - (`string `_) Kind is the type of resource being referenced - - -.. _api_field_k8s.io.api.core.v1.TypedLocalObjectReference.name: - -name - (`string `_) Name is the name of resource being referenced - - - - -.. _api_msg_k8s.io.api.core.v1.Volume: - -k8s.io.api.core.v1.Volume -------------------------- - -`[k8s.io.api.core.v1.Volume proto] `_ - -Volume represents a named volume in a pod that may be accessed by any container in the pod. - -.. code-block:: json - - { - "name": "...", - "volumeSource": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.Volume.name: - -name - (`string `_) Volume's name. - Must be a DNS_LABEL and unique within the pod. - More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names - - -.. _api_field_k8s.io.api.core.v1.Volume.volumeSource: - -volumeSource - (:ref:`k8s.io.api.core.v1.VolumeSource `) VolumeSource represents the location and type of the mounted volume. - If not specified, the Volume is implied to be an EmptyDir. - This implied behavior is deprecated and will be removed in a future version. - - - - -.. _api_msg_k8s.io.api.core.v1.VolumeDevice: - -k8s.io.api.core.v1.VolumeDevice -------------------------------- - -`[k8s.io.api.core.v1.VolumeDevice proto] `_ - -volumeDevice describes a mapping of a raw block device within a container. - -.. code-block:: json - - { - "name": "...", - "devicePath": "..." - } - -.. _api_field_k8s.io.api.core.v1.VolumeDevice.name: - -name - (`string `_) name must match the name of a persistentVolumeClaim in the pod - - -.. _api_field_k8s.io.api.core.v1.VolumeDevice.devicePath: - -devicePath - (`string `_) devicePath is the path inside of the container that the device will be mapped to. - - - - -.. _api_msg_k8s.io.api.core.v1.VolumeMount: - -k8s.io.api.core.v1.VolumeMount ------------------------------- - -`[k8s.io.api.core.v1.VolumeMount proto] `_ - -VolumeMount describes a mounting of a Volume within a container. - -.. code-block:: json - - { - "name": "...", - "readOnly": "...", - "mountPath": "...", - "subPath": "...", - "mountPropagation": "...", - "subPathExpr": "..." - } - -.. _api_field_k8s.io.api.core.v1.VolumeMount.name: - -name - (`string `_) This must match the Name of a Volume. - - -.. _api_field_k8s.io.api.core.v1.VolumeMount.readOnly: - -readOnly - (`bool `_) Mounted read-only if true, read-write otherwise (false or unspecified). - Defaults to false. - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeMount.mountPath: - -mountPath - (`string `_) Path within the container at which the volume should be mounted. Must - not contain ':'. - - -.. _api_field_k8s.io.api.core.v1.VolumeMount.subPath: - -subPath - (`string `_) Path within the volume from which the container's volume should be mounted. - Defaults to "" (volume's root). - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeMount.mountPropagation: - -mountPropagation - (`string `_) mountPropagation determines how mounts are propagated from the host - to container and the other way around. - When not set, MountPropagationNone is used. - This field is beta in 1.10. - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeMount.subPathExpr: - -subPathExpr - (`string `_) Expanded path within the volume from which the container's volume should be mounted. - Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment. - Defaults to "" (volume's root). - SubPathExpr and SubPath are mutually exclusive. - This field is alpha in 1.14. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.VolumeNodeAffinity: - -k8s.io.api.core.v1.VolumeNodeAffinity -------------------------------------- - -`[k8s.io.api.core.v1.VolumeNodeAffinity proto] `_ - -VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from. - -.. code-block:: json - - { - "required": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.VolumeNodeAffinity.required: - -required - (:ref:`k8s.io.api.core.v1.NodeSelector `) Required specifies hard node constraints that must be met. - - - - -.. _api_msg_k8s.io.api.core.v1.VolumeProjection: - -k8s.io.api.core.v1.VolumeProjection ------------------------------------ - -`[k8s.io.api.core.v1.VolumeProjection proto] `_ - -Projection that may be projected along with other supported volume types - -.. code-block:: json - - { - "secret": "{...}", - "downwardAPI": "{...}", - "configMap": "{...}", - "serviceAccountToken": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.VolumeProjection.secret: - -secret - (:ref:`k8s.io.api.core.v1.SecretProjection `) information about the secret data to project - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeProjection.downwardAPI: - -downwardAPI - (:ref:`k8s.io.api.core.v1.DownwardAPIProjection `) information about the downwardAPI data to project - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeProjection.configMap: - -configMap - (:ref:`k8s.io.api.core.v1.ConfigMapProjection `) information about the configMap data to project - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeProjection.serviceAccountToken: - -serviceAccountToken - (:ref:`k8s.io.api.core.v1.ServiceAccountTokenProjection `) information about the serviceAccountToken data to project - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.VolumeSource: - -k8s.io.api.core.v1.VolumeSource -------------------------------- - -`[k8s.io.api.core.v1.VolumeSource proto] `_ - -Represents the source of a volume to mount. -Only one of its members may be specified. - -.. code-block:: json - - { - "hostPath": "{...}", - "emptyDir": "{...}", - "gcePersistentDisk": "{...}", - "awsElasticBlockStore": "{...}", - "gitRepo": "{...}", - "secret": "{...}", - "nfs": "{...}", - "iscsi": "{...}", - "glusterfs": "{...}", - "persistentVolumeClaim": "{...}", - "rbd": "{...}", - "flexVolume": "{...}", - "cinder": "{...}", - "cephfs": "{...}", - "flocker": "{...}", - "downwardAPI": "{...}", - "fc": "{...}", - "azureFile": "{...}", - "configMap": "{...}", - "vsphereVolume": "{...}", - "quobyte": "{...}", - "azureDisk": "{...}", - "photonPersistentDisk": "{...}", - "projected": "{...}", - "portworxVolume": "{...}", - "scaleIO": "{...}", - "storageos": "{...}", - "csi": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.VolumeSource.hostPath: - -hostPath - (:ref:`k8s.io.api.core.v1.HostPathVolumeSource `) HostPath represents a pre-existing file or directory on the host - machine that is directly exposed to the container. This is generally - used for system agents or other privileged things that are allowed - to see the host machine. Most containers will NOT need this. - More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath - --- - TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not - mount host directories as read/write. - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.emptyDir: - -emptyDir - (:ref:`k8s.io.api.core.v1.EmptyDirVolumeSource `) EmptyDir represents a temporary directory that shares a pod's lifetime. - More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.gcePersistentDisk: - -gcePersistentDisk - (:ref:`k8s.io.api.core.v1.GCEPersistentDiskVolumeSource `) GCEPersistentDisk represents a GCE Disk resource that is attached to a - kubelet's host machine and then exposed to the pod. - More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.awsElasticBlockStore: - -awsElasticBlockStore - (:ref:`k8s.io.api.core.v1.AWSElasticBlockStoreVolumeSource `) AWSElasticBlockStore represents an AWS Disk resource that is attached to a - kubelet's host machine and then exposed to the pod. - More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.gitRepo: - -gitRepo - (:ref:`k8s.io.api.core.v1.GitRepoVolumeSource `) GitRepo represents a git repository at a particular revision. - DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an - EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir - into the Pod's container. - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.secret: - -secret - (:ref:`k8s.io.api.core.v1.SecretVolumeSource `) Secret represents a secret that should populate this volume. - More info: https://kubernetes.io/docs/concepts/storage/volumes#secret - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.nfs: - -nfs - (:ref:`k8s.io.api.core.v1.NFSVolumeSource `) NFS represents an NFS mount on the host that shares a pod's lifetime - More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.iscsi: - -iscsi - (:ref:`k8s.io.api.core.v1.ISCSIVolumeSource `) ISCSI represents an ISCSI Disk resource that is attached to a - kubelet's host machine and then exposed to the pod. - More info: https://releases.k8s.io/HEAD/examples/volumes/iscsi/README.md - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.glusterfs: - -glusterfs - (:ref:`k8s.io.api.core.v1.GlusterfsVolumeSource `) Glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. - More info: https://releases.k8s.io/HEAD/examples/volumes/glusterfs/README.md - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.persistentVolumeClaim: - -persistentVolumeClaim - (:ref:`k8s.io.api.core.v1.PersistentVolumeClaimVolumeSource `) PersistentVolumeClaimVolumeSource represents a reference to a - PersistentVolumeClaim in the same namespace. - More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.rbd: - -rbd - (:ref:`k8s.io.api.core.v1.RBDVolumeSource `) RBD represents a Rados Block Device mount on the host that shares a pod's lifetime. - More info: https://releases.k8s.io/HEAD/examples/volumes/rbd/README.md - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.flexVolume: - -flexVolume - (:ref:`k8s.io.api.core.v1.FlexVolumeSource `) FlexVolume represents a generic volume resource that is - provisioned/attached using an exec based plugin. - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.cinder: - -cinder - (:ref:`k8s.io.api.core.v1.CinderVolumeSource `) Cinder represents a cinder volume attached and mounted on kubelets host machine - More info: https://releases.k8s.io/HEAD/examples/mysql-cinder-pd/README.md - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.cephfs: - -cephfs - (:ref:`k8s.io.api.core.v1.CephFSVolumeSource `) CephFS represents a Ceph FS mount on the host that shares a pod's lifetime - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.flocker: - -flocker - (:ref:`k8s.io.api.core.v1.FlockerVolumeSource `) Flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.downwardAPI: - -downwardAPI - (:ref:`k8s.io.api.core.v1.DownwardAPIVolumeSource `) DownwardAPI represents downward API about the pod that should populate this volume - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.fc: - -fc - (:ref:`k8s.io.api.core.v1.FCVolumeSource `) FC represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod. - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.azureFile: - -azureFile - (:ref:`k8s.io.api.core.v1.AzureFileVolumeSource `) AzureFile represents an Azure File Service mount on the host and bind mount to the pod. - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.configMap: - -configMap - (:ref:`k8s.io.api.core.v1.ConfigMapVolumeSource `) ConfigMap represents a configMap that should populate this volume - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.vsphereVolume: - -vsphereVolume - (:ref:`k8s.io.api.core.v1.VsphereVirtualDiskVolumeSource `) VsphereVolume represents a vSphere volume attached and mounted on kubelets host machine - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.quobyte: - -quobyte - (:ref:`k8s.io.api.core.v1.QuobyteVolumeSource `) Quobyte represents a Quobyte mount on the host that shares a pod's lifetime - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.azureDisk: - -azureDisk - (:ref:`k8s.io.api.core.v1.AzureDiskVolumeSource `) AzureDisk represents an Azure Data Disk mount on the host and bind mount to the pod. - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.photonPersistentDisk: - -photonPersistentDisk - (:ref:`k8s.io.api.core.v1.PhotonPersistentDiskVolumeSource `) PhotonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.projected: - -projected - (:ref:`k8s.io.api.core.v1.ProjectedVolumeSource `) Items for all in one resources secrets, configmaps, and downward API - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.portworxVolume: - -portworxVolume - (:ref:`k8s.io.api.core.v1.PortworxVolumeSource `) PortworxVolume represents a portworx volume attached and mounted on kubelets host machine - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.scaleIO: - -scaleIO - (:ref:`k8s.io.api.core.v1.ScaleIOVolumeSource `) ScaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes. - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.storageos: - -storageos - (:ref:`k8s.io.api.core.v1.StorageOSVolumeSource `) StorageOS represents a StorageOS volume attached and mounted on Kubernetes nodes. - +optional - - -.. _api_field_k8s.io.api.core.v1.VolumeSource.csi: - -csi - (:ref:`k8s.io.api.core.v1.CSIVolumeSource `) CSI (Container Storage Interface) represents storage that is handled by an external CSI driver (Alpha feature). - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.VsphereVirtualDiskVolumeSource: - -k8s.io.api.core.v1.VsphereVirtualDiskVolumeSource -------------------------------------------------- - -`[k8s.io.api.core.v1.VsphereVirtualDiskVolumeSource proto] `_ - -Represents a vSphere volume resource. - -.. code-block:: json - - { - "volumePath": "...", - "fsType": "...", - "storagePolicyName": "...", - "storagePolicyID": "..." - } - -.. _api_field_k8s.io.api.core.v1.VsphereVirtualDiskVolumeSource.volumePath: - -volumePath - (`string `_) Path that identifies vSphere volume vmdk - - -.. _api_field_k8s.io.api.core.v1.VsphereVirtualDiskVolumeSource.fsType: - -fsType - (`string `_) Filesystem type to mount. - Must be a filesystem type supported by the host operating system. - Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. - +optional - - -.. _api_field_k8s.io.api.core.v1.VsphereVirtualDiskVolumeSource.storagePolicyName: - -storagePolicyName - (`string `_) Storage Policy Based Management (SPBM) profile name. - +optional - - -.. _api_field_k8s.io.api.core.v1.VsphereVirtualDiskVolumeSource.storagePolicyID: - -storagePolicyID - (`string `_) Storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName. - +optional - - - - -.. _api_msg_k8s.io.api.core.v1.WeightedPodAffinityTerm: - -k8s.io.api.core.v1.WeightedPodAffinityTerm ------------------------------------------- - -`[k8s.io.api.core.v1.WeightedPodAffinityTerm proto] `_ - -The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s) - -.. code-block:: json - - { - "weight": "...", - "podAffinityTerm": "{...}" - } - -.. _api_field_k8s.io.api.core.v1.WeightedPodAffinityTerm.weight: - -weight - (`int32 `_) weight associated with matching the corresponding podAffinityTerm, - in the range 1-100. - - -.. _api_field_k8s.io.api.core.v1.WeightedPodAffinityTerm.podAffinityTerm: - -podAffinityTerm - (:ref:`k8s.io.api.core.v1.PodAffinityTerm `) Required. A pod affinity term, associated with the corresponding weight. - - - diff --git a/flyteidl/gen/pb-protodoc/k8s.io/api/core/v1/index.rst b/flyteidl/gen/pb-protodoc/k8s.io/api/core/v1/index.rst deleted file mode 100644 index 23613b6ea7..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/api/core/v1/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -v1 -== - -.. toctree:: - :maxdepth: 1 - :caption: v1 - :name: v1toc - - generated.proto diff --git a/flyteidl/gen/pb-protodoc/k8s.io/api/index.rst b/flyteidl/gen/pb-protodoc/k8s.io/api/index.rst deleted file mode 100644 index f29fb341ae..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/api/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -api -=== - -.. toctree:: - :maxdepth: 1 - :caption: api - :name: apitoc - - core/index diff --git a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/index.rst b/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/index.rst deleted file mode 100644 index 6bc8a6b4ba..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -apimachinery -============ - -.. toctree:: - :maxdepth: 1 - :caption: apimachinery - :name: apimachinerytoc - - pkg/index diff --git a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/api/index.rst b/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/api/index.rst deleted file mode 100644 index 5fcae966f9..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/api/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -api -=== - -.. toctree:: - :maxdepth: 1 - :caption: api - :name: apitoc - - resource/index diff --git a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/api/resource/generated.proto.rst b/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/api/resource/generated.proto.rst deleted file mode 100644 index 1a32e87f27..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/api/resource/generated.proto.rst +++ /dev/null @@ -1,99 +0,0 @@ -.. _api_file_k8s.io/apimachinery/pkg/api/resource/generated.proto: - -generated.proto -==================================================== - - -opyright The Kubernetes Authors. - -icensed under the Apache License, Version 2.0 (the "License"); -ou may not use this file except in compliance with the License. -ou may obtain a copy of the License at - -ttp://www.apache.org/licenses/LICENSE-2.0 - -nless required by applicable law or agreed to in writing, software -istributed under the License is distributed on an "AS IS" BASIS, -ITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -ee the License for the specific language governing permissions and -imitations under the License. -This file was autogenerated by go-to-protobuf. Do not edit it manually! - -.. _api_msg_k8s.io.apimachinery.pkg.api.resource.Quantity: - -k8s.io.apimachinery.pkg.api.resource.Quantity ---------------------------------------------- - -`[k8s.io.apimachinery.pkg.api.resource.Quantity proto] `_ - -Quantity is a fixed-point representation of a number. -It provides convenient marshaling/unmarshaling in JSON and YAML, -in addition to String() and Int64() accessors. - -The serialization format is: - - ::= - (Note that may be empty, from the "" case in .) - ::= 0 | 1 | ... | 9 - ::= | - ::= | . | . | . - ::= "+" | "-" - ::= | - ::= | | - ::= Ki | Mi | Gi | Ti | Pi | Ei - (International System of units; See: http://physics.nist.gov/cuu/Units/binary.html) - ::= m | "" | k | M | G | T | P | E - (Note that 1024 = 1Ki but 1000 = 1k; I didn't choose the capitalization.) - ::= "e" | "E" - -No matter which of the three exponent forms is used, no quantity may represent -a number greater than 2^63-1 in magnitude, nor may it have more than 3 decimal -places. Numbers larger or more precise will be capped or rounded up. -(E.g.: 0.1m will rounded up to 1m.) -This may be extended in the future if we require larger or smaller quantities. - -When a Quantity is parsed from a string, it will remember the type of suffix -it had, and will use the same type again when it is serialized. - -Before serializing, Quantity will be put in "canonical form". -This means that Exponent/suffix will be adjusted up or down (with a -corresponding increase or decrease in Mantissa) such that: - a. No precision is lost - b. No fractional digits will be emitted - c. The exponent (or suffix) is as large as possible. -The sign will be omitted unless the number is negative. - -Examples: - 1.5 will be serialized as "1500m" - 1.5Gi will be serialized as "1536Mi" - -Note that the quantity will NEVER be internally represented by a -floating point number. That is the whole point of this exercise. - -Non-canonical values will still parse as long as they are well formed, -but will be re-emitted in their canonical form. (So always use canonical -form, or don't diff.) - -This format is intended to make it difficult to use these numbers without -writing some sort of special handling code in the hopes that that will -cause implementors to also use a fixed point implementation. - -+protobuf=true -+protobuf.embed=string -+protobuf.options.marshal=false -+protobuf.options.(gogoproto.goproto_stringer)=false -+k8s:deepcopy-gen=true -+k8s:openapi-gen=true - -.. code-block:: json - - { - "string": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.api.resource.Quantity.string: - -string - (`string `_) - - diff --git a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/api/resource/index.rst b/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/api/resource/index.rst deleted file mode 100644 index 7c8295fec3..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/api/resource/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -resource -======== - -.. toctree:: - :maxdepth: 1 - :caption: resource - :name: resourcetoc - - generated.proto diff --git a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/apis/index.rst b/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/apis/index.rst deleted file mode 100644 index a06d0ee673..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/apis/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -apis -==== - -.. toctree:: - :maxdepth: 1 - :caption: apis - :name: apistoc - - meta/index diff --git a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/apis/meta/index.rst b/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/apis/meta/index.rst deleted file mode 100644 index 730d468df0..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/apis/meta/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -meta -==== - -.. toctree:: - :maxdepth: 1 - :caption: meta - :name: metatoc - - v1/index diff --git a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto.rst b/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto.rst deleted file mode 100644 index 3e485f655b..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto.rst +++ /dev/null @@ -1,1991 +0,0 @@ -.. _api_file_k8s.io/apimachinery/pkg/apis/meta/v1/generated.proto: - -generated.proto -==================================================== - - -opyright The Kubernetes Authors. - -icensed under the Apache License, Version 2.0 (the "License"); -ou may not use this file except in compliance with the License. -ou may obtain a copy of the License at - -ttp://www.apache.org/licenses/LICENSE-2.0 - -nless required by applicable law or agreed to in writing, software -istributed under the License is distributed on an "AS IS" BASIS, -ITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -ee the License for the specific language governing permissions and -imitations under the License. -This file was autogenerated by go-to-protobuf. Do not edit it manually! - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.APIGroup: - -k8s.io.apimachinery.pkg.apis.meta.v1.APIGroup ---------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.APIGroup proto] `_ - -APIGroup contains the name, the supported versions, and the preferred version -of a group. - -.. code-block:: json - - { - "name": "...", - "versions": [], - "preferredVersion": "{...}", - "serverAddressByClientCIDRs": [] - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIGroup.name: - -name - (`string `_) name is the name of the group. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIGroup.versions: - -versions - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery `) versions are the versions supported in this group. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIGroup.preferredVersion: - -preferredVersion - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery `) preferredVersion is the version preferred by the API server, which - probably is the storage version. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIGroup.serverAddressByClientCIDRs: - -serverAddressByClientCIDRs - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR `) a map of client CIDR to server address that is serving this group. - This is to help clients reach servers in the most network-efficient way possible. - Clients can use the appropriate server address as per the CIDR that they match. - In case of multiple matches, clients should use the longest matching CIDR. - The server returns only those CIDRs that it thinks that the client can match. - For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. - Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. - +optional - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.APIGroupList: - -k8s.io.apimachinery.pkg.apis.meta.v1.APIGroupList -------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.APIGroupList proto] `_ - -APIGroupList is a list of APIGroup, to allow clients to discover the API at -/apis. - -.. code-block:: json - - { - "groups": [] - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIGroupList.groups: - -groups - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.APIGroup `) groups is a list of APIGroup. - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.APIResource: - -k8s.io.apimachinery.pkg.apis.meta.v1.APIResource ------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.APIResource proto] `_ - -APIResource specifies the name of a resource and whether it is namespaced. - -.. code-block:: json - - { - "name": "...", - "singularName": "...", - "namespaced": "...", - "group": "...", - "version": "...", - "kind": "...", - "verbs": "{...}", - "shortNames": [], - "categories": [], - "storageVersionHash": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIResource.name: - -name - (`string `_) name is the plural name of the resource. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIResource.singularName: - -singularName - (`string `_) singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. - The singularName is more correct for reporting status on a single item and both singular and plural are allowed - from the kubectl CLI interface. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIResource.namespaced: - -namespaced - (`bool `_) namespaced indicates if a resource is namespaced or not. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIResource.group: - -group - (`string `_) group is the preferred group of the resource. Empty implies the group of the containing resource list. - For subresources, this may have a different value, for example: Scale". - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIResource.version: - -version - (`string `_) version is the preferred version of the resource. Empty implies the version of the containing resource list - For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)". - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIResource.kind: - -kind - (`string `_) kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo') - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIResource.verbs: - -verbs - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Verbs `) verbs is a list of supported kube verbs (this includes get, list, watch, create, - update, patch, delete, deletecollection, and proxy) - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIResource.shortNames: - -shortNames - (`string `_) shortNames is a list of suggested short names of the resource. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIResource.categories: - -categories - (`string `_) categories is a list of the grouped resources this resource belongs to (e.g. 'all') - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIResource.storageVersionHash: - -storageVersionHash - (`string `_) The hash value of the storage version, the version this resource is - converted to when written to the data store. Value must be treated - as opaque by clients. Only equality comparison on the value is valid. - This is an alpha feature and may change or be removed in the future. - The field is populated by the apiserver only if the - StorageVersionHash feature gate is enabled. - This field will remain optional even if it graduates. - +optional - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.APIResourceList: - -k8s.io.apimachinery.pkg.apis.meta.v1.APIResourceList ----------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.APIResourceList proto] `_ - -APIResourceList is a list of APIResource, it is used to expose the name of the -resources supported in a specific group and version, and if the resource -is namespaced. - -.. code-block:: json - - { - "groupVersion": "...", - "resources": [] - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIResourceList.groupVersion: - -groupVersion - (`string `_) groupVersion is the group and version this APIResourceList is for. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIResourceList.resources: - -resources - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.APIResource `) resources contains the name of the resources and if they are namespaced. - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.APIVersions: - -k8s.io.apimachinery.pkg.apis.meta.v1.APIVersions ------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.APIVersions proto] `_ - -APIVersions lists the versions that are available, to allow clients to -discover the API at /api, which is the root path of the legacy v1 API. - -+protobuf.options.(gogoproto.goproto_stringer)=false -+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object - -.. code-block:: json - - { - "versions": [], - "serverAddressByClientCIDRs": [] - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIVersions.versions: - -versions - (`string `_) versions are the api versions that are available. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.APIVersions.serverAddressByClientCIDRs: - -serverAddressByClientCIDRs - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR `) a map of client CIDR to server address that is serving this group. - This is to help clients reach servers in the most network-efficient way possible. - Clients can use the appropriate server address as per the CIDR that they match. - In case of multiple matches, clients should use the longest matching CIDR. - The server returns only those CIDRs that it thinks that the client can match. - For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. - Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP. - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.CreateOptions: - -k8s.io.apimachinery.pkg.apis.meta.v1.CreateOptions --------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.CreateOptions proto] `_ - -CreateOptions may be provided when creating an API object. - -.. code-block:: json - - { - "dryRun": [] - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.CreateOptions.dryRun: - -dryRun - (`string `_) When present, indicates that modifications should not be - persisted. An invalid or unrecognized dryRun directive will - result in an error response and no further processing of the - request. Valid values are: - - All: all dry run stages will be processed - +optional - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.DeleteOptions: - -k8s.io.apimachinery.pkg.apis.meta.v1.DeleteOptions --------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.DeleteOptions proto] `_ - -DeleteOptions may be provided when deleting an API object. - -.. code-block:: json - - { - "gracePeriodSeconds": "...", - "preconditions": "{...}", - "orphanDependents": "...", - "propagationPolicy": "...", - "dryRun": [] - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.DeleteOptions.gracePeriodSeconds: - -gracePeriodSeconds - (`int64 `_) The duration in seconds before the object should be deleted. Value must be non-negative integer. - The value zero indicates delete immediately. If this value is nil, the default grace period for the - specified type will be used. - Defaults to a per object value if not specified. zero means delete immediately. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.DeleteOptions.preconditions: - -preconditions - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Preconditions `) Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be - returned. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.DeleteOptions.orphanDependents: - -orphanDependents - (`bool `_) Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. - Should the dependent objects be orphaned. If true/false, the "orphan" - finalizer will be added to/removed from the object's finalizers list. - Either this field or PropagationPolicy may be set, but not both. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.DeleteOptions.propagationPolicy: - -propagationPolicy - (`string `_) Whether and how garbage collection will be performed. - Either this field or OrphanDependents may be set, but not both. - The default policy is decided by the existing finalizer set in the - metadata.finalizers and the resource-specific default policy. - Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - - allow the garbage collector to delete the dependents in the background; - 'Foreground' - a cascading policy that deletes all dependents in the - foreground. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.DeleteOptions.dryRun: - -dryRun - (`string `_) When present, indicates that modifications should not be - persisted. An invalid or unrecognized dryRun directive will - result in an error response and no further processing of the - request. Valid values are: - - All: all dry run stages will be processed - +optional - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.Duration: - -k8s.io.apimachinery.pkg.apis.meta.v1.Duration ---------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.Duration proto] `_ - -Duration is a wrapper around time.Duration which supports correct -marshaling to YAML and JSON. In particular, it marshals into strings, which -can be used as map keys in json. - -.. code-block:: json - - { - "duration": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.Duration.duration: - -duration - (`int64 `_) - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.ExportOptions: - -k8s.io.apimachinery.pkg.apis.meta.v1.ExportOptions --------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.ExportOptions proto] `_ - -ExportOptions is the query options to the standard REST get call. -Deprecated. Planned for removal in 1.18. - -.. code-block:: json - - { - "export": "...", - "exact": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ExportOptions.export: - -export - (`bool `_) Should this value be exported. Export strips fields that a user can not specify. - Deprecated. Planned for removal in 1.18. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ExportOptions.exact: - -exact - (`bool `_) Should the export be exact. Exact export maintains cluster-specific fields like 'Namespace'. - Deprecated. Planned for removal in 1.18. - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.Fields: - -k8s.io.apimachinery.pkg.apis.meta.v1.Fields -------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.Fields proto] `_ - -Fields stores a set of fields in a data structure like a Trie. -To understand how this is used, see: https://github.com/kubernetes-sigs/structured-merge-diff - -.. code-block:: json - - { - "map": "{...}" - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.Fields.map: - -map - (map<`string `_, :ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Fields `>) Map stores a set of fields in a data structure like a Trie. - - Each key is either a '.' representing the field itself, and will always map to an empty set, - or a string representing a sub-field or item. The string will follow one of these four formats: - 'f:', where is the name of a field in a struct, or key in a map - 'v:', where is the exact json formatted value of a list item - 'i:', where is position of a item in a list - 'k:', where is a map of a list item's key fields to their unique values - If a key maps to an empty Fields value, the field that key represents is part of the set. - - The exact format is defined in k8s.io/apiserver/pkg/endpoints/handlers/fieldmanager/internal - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.GetOptions: - -k8s.io.apimachinery.pkg.apis.meta.v1.GetOptions ------------------------------------------------ - -`[k8s.io.apimachinery.pkg.apis.meta.v1.GetOptions proto] `_ - -GetOptions is the standard query options to the standard REST get call. - -.. code-block:: json - - { - "resourceVersion": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.GetOptions.resourceVersion: - -resourceVersion - (`string `_) When specified: - - if unset, then the result is returned from remote storage based on quorum-read flag; - - if it's 0, then we simply return what we currently have in cache, no guarantee; - - if set to non zero, then the result is at least as fresh as given rv. - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.GroupKind: - -k8s.io.apimachinery.pkg.apis.meta.v1.GroupKind ----------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.GroupKind proto] `_ - -GroupKind specifies a Group and a Kind, but does not force a version. This is useful for identifying -concepts during lookup stages without having partially valid types - -+protobuf.options.(gogoproto.goproto_stringer)=false - -.. code-block:: json - - { - "group": "...", - "kind": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.GroupKind.group: - -group - (`string `_) - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.GroupKind.kind: - -kind - (`string `_) - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.GroupResource: - -k8s.io.apimachinery.pkg.apis.meta.v1.GroupResource --------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.GroupResource proto] `_ - -GroupResource specifies a Group and a Resource, but does not force a version. This is useful for identifying -concepts during lookup stages without having partially valid types - -+protobuf.options.(gogoproto.goproto_stringer)=false - -.. code-block:: json - - { - "group": "...", - "resource": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.GroupResource.group: - -group - (`string `_) - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.GroupResource.resource: - -resource - (`string `_) - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersion: - -k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersion -------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersion proto] `_ - -GroupVersion contains the "group" and the "version", which uniquely identifies the API. - -+protobuf.options.(gogoproto.goproto_stringer)=false - -.. code-block:: json - - { - "group": "...", - "version": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersion.group: - -group - (`string `_) - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersion.version: - -version - (`string `_) - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery: - -k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery -------------------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery proto] `_ - -GroupVersion contains the "group/version" and "version" string of a version. -It is made a struct to keep extensibility. - -.. code-block:: json - - { - "groupVersion": "...", - "version": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery.groupVersion: - -groupVersion - (`string `_) groupVersion specifies the API group and version in the form "group/version" - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionForDiscovery.version: - -version - (`string `_) version specifies the version in the form of "version". This is to save - the clients the trouble of splitting the GroupVersion. - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionKind: - -k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionKind ------------------------------------------------------ - -`[k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionKind proto] `_ - -GroupVersionKind unambiguously identifies a kind. It doesn't anonymously include GroupVersion -to avoid automatic coersion. It doesn't use a GroupVersion to avoid custom marshalling - -+protobuf.options.(gogoproto.goproto_stringer)=false - -.. code-block:: json - - { - "group": "...", - "version": "...", - "kind": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionKind.group: - -group - (`string `_) - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionKind.version: - -version - (`string `_) - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionKind.kind: - -kind - (`string `_) - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionResource: - -k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionResource ---------------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionResource proto] `_ - -GroupVersionResource unambiguously identifies a resource. It doesn't anonymously include GroupVersion -to avoid automatic coersion. It doesn't use a GroupVersion to avoid custom marshalling - -+protobuf.options.(gogoproto.goproto_stringer)=false - -.. code-block:: json - - { - "group": "...", - "version": "...", - "resource": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionResource.group: - -group - (`string `_) - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionResource.version: - -version - (`string `_) - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.GroupVersionResource.resource: - -resource - (`string `_) - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.Initializer: - -k8s.io.apimachinery.pkg.apis.meta.v1.Initializer ------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.Initializer proto] `_ - -Initializer is information about an initializer that has not yet completed. - -.. code-block:: json - - { - "name": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.Initializer.name: - -name - (`string `_) name of the process that is responsible for initializing this object. - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.Initializers: - -k8s.io.apimachinery.pkg.apis.meta.v1.Initializers -------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.Initializers proto] `_ - -Initializers tracks the progress of initialization. - -.. code-block:: json - - { - "pending": [], - "result": "{...}" - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.Initializers.pending: - -pending - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Initializer `) Pending is a list of initializers that must execute in order before this object is visible. - When the last pending initializer is removed, and no failing result is set, the initializers - struct will be set to nil and the object is considered as initialized and visible to all - clients. - +patchMergeKey=name - +patchStrategy=merge - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.Initializers.result: - -result - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Status `) If result is set with the Failure field, the object will be persisted to storage and then deleted, - ensuring that other clients can observe the deletion. - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector: - -k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector --------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector proto] `_ - -A label selector is a label query over a set of resources. The result of matchLabels and -matchExpressions are ANDed. An empty label selector matches all objects. A null -label selector matches no objects. - -.. code-block:: json - - { - "matchLabels": "{...}", - "matchExpressions": [] - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector.matchLabels: - -matchLabels - (map<`string `_, `string `_>) matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels - map is equivalent to an element of matchExpressions, whose key field is "key", the - operator is "In", and the values array contains only "value". The requirements are ANDed. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelector.matchExpressions: - -matchExpressions - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement `) matchExpressions is a list of label selector requirements. The requirements are ANDed. - +optional - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement: - -k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement -------------------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement proto] `_ - -A label selector requirement is a selector that contains values, a key, and an operator that -relates the key and values. - -.. code-block:: json - - { - "key": "...", - "operator": "...", - "values": [] - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement.key: - -key - (`string `_) key is the label key that the selector applies to. - +patchMergeKey=key - +patchStrategy=merge - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement.operator: - -operator - (`string `_) operator represents a key's relationship to a set of values. - Valid operators are In, NotIn, Exists and DoesNotExist. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.LabelSelectorRequirement.values: - -values - (`string `_) values is an array of string values. If the operator is In or NotIn, - the values array must be non-empty. If the operator is Exists or DoesNotExist, - the values array must be empty. This array is replaced during a strategic - merge patch. - +optional - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.List: - -k8s.io.apimachinery.pkg.apis.meta.v1.List ------------------------------------------ - -`[k8s.io.apimachinery.pkg.apis.meta.v1.List proto] `_ - -List holds a list of objects, which may not be known by the server. - -.. code-block:: json - - { - "metadata": "{...}", - "items": [] - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.List.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.List.items: - -items - (:ref:`k8s.io.apimachinery.pkg.runtime.RawExtension `) List of objects - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta: - -k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta ---------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta proto] `_ - -ListMeta describes metadata that synthetic resources must have, including lists and -various status objects. A resource may have only one of {ObjectMeta, ListMeta}. - -.. code-block:: json - - { - "selfLink": "...", - "resourceVersion": "...", - "continue": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta.selfLink: - -selfLink - (`string `_) selfLink is a URL representing this object. - Populated by the system. - Read-only. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta.resourceVersion: - -resourceVersion - (`string `_) String that identifies the server's internal version of this object that - can be used by clients to determine when objects have changed. - Value must be treated as opaque by clients and passed unmodified back to the server. - Populated by the system. - Read-only. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta.continue: - -continue - (`string `_) continue may be set if the user set a limit on the number of items returned, and indicates that - the server has more data available. The value is opaque and may be used to issue another request - to the endpoint that served this list to retrieve the next set of available objects. Continuing a - consistent list may not be possible if the server configuration has changed or more than a few - minutes have passed. The resourceVersion field returned when using this continue value will be - identical to the value in the first response, unless you have received this token from an error - message. - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.ListOptions: - -k8s.io.apimachinery.pkg.apis.meta.v1.ListOptions ------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.ListOptions proto] `_ - -ListOptions is the query options to a standard REST list call. - -.. code-block:: json - - { - "labelSelector": "...", - "fieldSelector": "...", - "watch": "...", - "resourceVersion": "...", - "timeoutSeconds": "...", - "limit": "...", - "continue": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ListOptions.labelSelector: - -labelSelector - (`string `_) A selector to restrict the list of returned objects by their labels. - Defaults to everything. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ListOptions.fieldSelector: - -fieldSelector - (`string `_) A selector to restrict the list of returned objects by their fields. - Defaults to everything. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ListOptions.watch: - -watch - (`bool `_) Watch for changes to the described resources and return them as a stream of - add, update, and remove notifications. Specify resourceVersion. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ListOptions.resourceVersion: - -resourceVersion - (`string `_) When specified with a watch call, shows changes that occur after that particular version of a resource. - Defaults to changes from the beginning of history. - When specified for list: - - if unset, then the result is returned from remote storage based on quorum-read flag; - - if it's 0, then we simply return what we currently have in cache, no guarantee; - - if set to non zero, then the result is at least as fresh as given rv. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ListOptions.timeoutSeconds: - -timeoutSeconds - (`int64 `_) Timeout for the list/watch call. - This limits the duration of the call, regardless of any activity or inactivity. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ListOptions.limit: - -limit - (`int64 `_) 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. - - The 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. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ListOptions.continue: - -continue - (`string `_) 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". - - This 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. - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry: - -k8s.io.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry -------------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry proto] `_ - -ManagedFieldsEntry is a workflow-id, a FieldSet and the group version of the resource -that the fieldset applies to. - -.. code-block:: json - - { - "manager": "...", - "operation": "...", - "apiVersion": "...", - "time": "{...}", - "fields": "{...}" - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry.manager: - -manager - (`string `_) Manager is an identifier of the workflow managing these fields. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry.operation: - -operation - (`string `_) Operation is the type of operation which lead to this ManagedFieldsEntry being created. - The only valid values for this field are 'Apply' and 'Update'. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry.apiVersion: - -apiVersion - (`string `_) APIVersion defines the version of this resource that this field set - applies to. The format is "group/version" just like the top-level - APIVersion field. It is necessary to track the version of a field - set because it cannot be automatically converted. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry.time: - -time - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) Time is timestamp of when these fields were set. It should always be empty if Operation is 'Apply' - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry.fields: - -fields - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Fields `) Fields identifies a set of fields. - +optional - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.MicroTime: - -k8s.io.apimachinery.pkg.apis.meta.v1.MicroTime ----------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.MicroTime proto] `_ - -MicroTime is version of Time with microsecond level precision. - -+protobuf.options.marshal=false -+protobuf.as=Timestamp -+protobuf.options.(gogoproto.goproto_stringer)=false - -.. code-block:: json - - { - "seconds": "...", - "nanos": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.MicroTime.seconds: - -seconds - (`int64 `_) Represents seconds of UTC time since Unix epoch - 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to - 9999-12-31T23:59:59Z inclusive. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.MicroTime.nanos: - -nanos - (`int32 `_) Non-negative fractions of a second at nanosecond resolution. Negative - second values with fractions must still have non-negative nanos values - that count forward in time. Must be from 0 to 999,999,999 - inclusive. This field may be limited in precision depending on context. - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta: - -k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta ------------------------------------------------ - -`[k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta proto] `_ - -ObjectMeta is metadata that all persisted resources must have, which includes all objects -users must create. - -.. code-block:: json - - { - "name": "...", - "generateName": "...", - "namespace": "...", - "selfLink": "...", - "uid": "...", - "resourceVersion": "...", - "generation": "...", - "creationTimestamp": "{...}", - "deletionTimestamp": "{...}", - "deletionGracePeriodSeconds": "...", - "labels": "{...}", - "annotations": "{...}", - "ownerReferences": [], - "initializers": "{...}", - "finalizers": [], - "clusterName": "...", - "managedFields": [] - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.name: - -name - (`string `_) Name must be unique within a namespace. Is required when creating resources, although - some resources may allow a client to request the generation of an appropriate name - automatically. Name is primarily intended for creation idempotence and configuration - definition. - Cannot be updated. - More info: http://kubernetes.io/docs/user-guide/identifiers#names - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.generateName: - -generateName - (`string `_) GenerateName is an optional prefix, used by the server, to generate a unique - name ONLY IF the Name field has not been provided. - If this field is used, the name returned to the client will be different - than the name passed. This value will also be combined with a unique suffix. - The provided value has the same validation rules as the Name field, - and may be truncated by the length of the suffix required to make the value - unique on the server. - - If this field is specified and the generated name exists, the server will - NOT return a 409 - instead, it will either return 201 Created or 500 with Reason - ServerTimeout indicating a unique name could not be found in the time allotted, and the client - should retry (optionally after the time indicated in the Retry-After header). - - Applied only if Name is not specified. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.namespace: - -namespace - (`string `_) Namespace defines the space within each name must be unique. An empty namespace is - equivalent to the "default" namespace, but "default" is the canonical representation. - Not all objects are required to be scoped to a namespace - the value of this field for - those objects will be empty. - - Must be a DNS_LABEL. - Cannot be updated. - More info: http://kubernetes.io/docs/user-guide/namespaces - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.selfLink: - -selfLink - (`string `_) SelfLink is a URL representing this object. - Populated by the system. - Read-only. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.uid: - -uid - (`string `_) UID is the unique in time and space value for this object. It is typically generated by - the server on successful creation of a resource and is not allowed to change on PUT - operations. - - Populated by the system. - Read-only. - More info: http://kubernetes.io/docs/user-guide/identifiers#uids - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.resourceVersion: - -resourceVersion - (`string `_) An opaque value that represents the internal version of this object that can - be used by clients to determine when objects have changed. May be used for optimistic - concurrency, change detection, and the watch operation on a resource or set of resources. - Clients must treat these values as opaque and passed unmodified back to the server. - They may only be valid for a particular resource or set of resources. - - Populated by the system. - Read-only. - Value must be treated as opaque by clients and . - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.generation: - -generation - (`int64 `_) A sequence number representing a specific generation of the desired state. - Populated by the system. Read-only. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.creationTimestamp: - -creationTimestamp - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) CreationTimestamp is a timestamp representing the server time when this object was - created. It is not guaranteed to be set in happens-before order across separate operations. - Clients may not set this value. It is represented in RFC3339 form and is in UTC. - - Populated by the system. - Read-only. - Null for lists. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.deletionTimestamp: - -deletionTimestamp - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Time `) DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This - field is set by the server when a graceful deletion is requested by the user, and is not - directly settable by a client. The resource is expected to be deleted (no longer visible - from resource lists, and not reachable by name) after the time in this field, once the - finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. - Once the deletionTimestamp is set, this value may not be unset or be set further into the - future, although it may be shortened or the resource may be deleted prior to this time. - For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react - by sending a graceful termination signal to the containers in the pod. After that 30 seconds, - the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, - remove the pod from the API. In the presence of network partitions, this object may still - exist after this timestamp, until an administrator or automated process can determine the - resource is fully terminated. - If not set, graceful deletion of the object has not been requested. - - Populated by the system when a graceful deletion is requested. - Read-only. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.deletionGracePeriodSeconds: - -deletionGracePeriodSeconds - (`int64 `_) Number of seconds allowed for this object to gracefully terminate before - it will be removed from the system. Only set when deletionTimestamp is also set. - May only be shortened. - Read-only. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.labels: - -labels - (map<`string `_, `string `_>) Map of string keys and values that can be used to organize and categorize - (scope and select) objects. May match selectors of replication controllers - and services. - More info: http://kubernetes.io/docs/user-guide/labels - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.annotations: - -annotations - (map<`string `_, `string `_>) Annotations is an unstructured key value map stored with a resource that may be - set by external tools to store and retrieve arbitrary metadata. They are not - queryable and should be preserved when modifying objects. - More info: http://kubernetes.io/docs/user-guide/annotations - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.ownerReferences: - -ownerReferences - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference `) List of objects depended by this object. If ALL objects in the list have - been deleted, this object will be garbage collected. If this object is managed by a controller, - then an entry in this list will point to this controller, with the controller field set to true. - There cannot be more than one managing controller. - +optional - +patchMergeKey=uid - +patchStrategy=merge - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.initializers: - -initializers - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.Initializers `) An initializer is a controller which enforces some system invariant at object creation time. - This field is a list of initializers that have not yet acted on this object. If nil or empty, - this object has been completely initialized. Otherwise, the object is considered uninitialized - and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to - observe uninitialized objects. - - When an object is created, the system will populate this list with the current set of initializers. - Only privileged users may set or modify this list. Once it is empty, it may not be modified further - by any user. - - DEPRECATED - initializers are an alpha field and will be removed in v1.15. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.finalizers: - -finalizers - (`string `_) Must be empty before the object is deleted from the registry. Each entry - is an identifier for the responsible component that will remove the entry - from the list. If the deletionTimestamp of the object is non-nil, entries - in this list can only be removed. - +optional - +patchStrategy=merge - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.clusterName: - -clusterName - (`string `_) The name of the cluster which the object belongs to. - This is used to distinguish resources with same name and namespace in different clusters. - This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ObjectMeta.managedFields: - -managedFields - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ManagedFieldsEntry `) ManagedFields maps workflow-id and version to the set of fields - that are managed by that workflow. This is mostly for internal - housekeeping, and users typically shouldn't need to set or - understand this field. A workflow can be the user's name, a - controller's name, or the name of a specific apply path like - "ci-cd". The set of fields is always in the version that the - workflow used when modifying the object. - - This field is alpha and can be changed or removed without notice. - - +optional - - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference: - -k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference ---------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference proto] `_ - -OwnerReference contains enough information to let you identify an owning -object. An owning object must be in the same namespace as the dependent, or -be cluster-scoped, so there is no namespace field. - -.. code-block:: json - - { - "apiVersion": "...", - "kind": "...", - "name": "...", - "uid": "...", - "controller": "...", - "blockOwnerDeletion": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference.apiVersion: - -apiVersion - (`string `_) API version of the referent. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference.kind: - -kind - (`string `_) Kind of the referent. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference.name: - -name - (`string `_) Name of the referent. - More info: http://kubernetes.io/docs/user-guide/identifiers#names - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference.uid: - -uid - (`string `_) UID of the referent. - More info: http://kubernetes.io/docs/user-guide/identifiers#uids - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference.controller: - -controller - (`bool `_) If true, this reference points to the managing controller. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.OwnerReference.blockOwnerDeletion: - -blockOwnerDeletion - (`bool `_) If true, AND if the owner has the "foregroundDeletion" finalizer, then - the owner cannot be deleted from the key-value store until this - reference is removed. - Defaults to false. - To set this field, a user needs "delete" permission of the owner, - otherwise 422 (Unprocessable Entity) will be returned. - +optional - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.Patch: - -k8s.io.apimachinery.pkg.apis.meta.v1.Patch ------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.Patch proto] `_ - -Patch is provided to give a concrete name and type to the Kubernetes PATCH request body. - -.. code-block:: json - - {} - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.PatchOptions: - -k8s.io.apimachinery.pkg.apis.meta.v1.PatchOptions -------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.PatchOptions proto] `_ - -PatchOptions may be provided when patching an API object. -PatchOptions is meant to be a superset of UpdateOptions. - -.. code-block:: json - - { - "dryRun": [], - "force": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.PatchOptions.dryRun: - -dryRun - (`string `_) When present, indicates that modifications should not be - persisted. An invalid or unrecognized dryRun directive will - result in an error response and no further processing of the - request. Valid values are: - - All: all dry run stages will be processed - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.PatchOptions.force: - -force - (`bool `_) Force is going to "force" Apply requests. It means user will - re-acquire conflicting fields owned by other people. Force - flag must be unset for non-apply patch requests. - +optional - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.Preconditions: - -k8s.io.apimachinery.pkg.apis.meta.v1.Preconditions --------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.Preconditions proto] `_ - -Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out. - -.. code-block:: json - - { - "uid": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.Preconditions.uid: - -uid - (`string `_) Specifies the target UID. - +optional - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.RootPaths: - -k8s.io.apimachinery.pkg.apis.meta.v1.RootPaths ----------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.RootPaths proto] `_ - -RootPaths lists the paths available at root. -For example: "/healthz", "/apis". - -.. code-block:: json - - { - "paths": [] - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.RootPaths.paths: - -paths - (`string `_) paths are the paths available at root. - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR: - -k8s.io.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR --------------------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR proto] `_ - -ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match. - -.. code-block:: json - - { - "clientCIDR": "...", - "serverAddress": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR.clientCIDR: - -clientCIDR - (`string `_) The CIDR with which clients can match their IP to figure out the server address that they should use. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.ServerAddressByClientCIDR.serverAddress: - -serverAddress - (`string `_) Address of this server, suitable for a client that matches the above CIDR. - This can be a hostname, hostname:port, IP or IP:port. - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.Status: - -k8s.io.apimachinery.pkg.apis.meta.v1.Status -------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.Status proto] `_ - -Status is a return value for calls that don't return other objects. - -.. code-block:: json - - { - "metadata": "{...}", - "status": "...", - "message": "...", - "reason": "...", - "details": "{...}", - "code": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.Status.metadata: - -metadata - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.ListMeta `) Standard list metadata. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.Status.status: - -status - (`string `_) Status of the operation. - One of: "Success" or "Failure". - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.Status.message: - -message - (`string `_) A human-readable description of the status of this operation. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.Status.reason: - -reason - (`string `_) A machine-readable description of why this operation is in the - "Failure" status. If this value is empty there - is no information available. A Reason clarifies an HTTP status - code but does not override it. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.Status.details: - -details - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.StatusDetails `) Extended data associated with the reason. Each reason may define its - own extended details. This field is optional and the data returned - is not guaranteed to conform to any schema except that defined by - the reason type. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.Status.code: - -code - (`int32 `_) Suggested HTTP return code for this status, 0 if not set. - +optional - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.StatusCause: - -k8s.io.apimachinery.pkg.apis.meta.v1.StatusCause ------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.StatusCause proto] `_ - -StatusCause provides more information about an api.Status failure, including -cases when multiple errors are encountered. - -.. code-block:: json - - { - "reason": "...", - "message": "...", - "field": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.StatusCause.reason: - -reason - (`string `_) A machine-readable description of the cause of the error. If this value is - empty there is no information available. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.StatusCause.message: - -message - (`string `_) A human-readable description of the cause of the error. This field may be - presented as-is to a reader. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.StatusCause.field: - -field - (`string `_) The field of the resource that has caused this error, as named by its JSON - serialization. May include dot and postfix notation for nested attributes. - Arrays are zero-indexed. Fields may appear more than once in an array of - causes due to fields having multiple errors. - Optional. - - Examples: - "name" - the field "name" on the current resource - "items[0].name" - the field "name" on the first array entry in "items" - +optional - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.StatusDetails: - -k8s.io.apimachinery.pkg.apis.meta.v1.StatusDetails --------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.StatusDetails proto] `_ - -StatusDetails is a set of additional properties that MAY be set by the -server to provide additional information about a response. The Reason -field of a Status object defines what attributes will be set. Clients -must ignore fields that do not match the defined type of each attribute, -and should assume that any attribute may be empty, invalid, or under -defined. - -.. code-block:: json - - { - "name": "...", - "group": "...", - "kind": "...", - "uid": "...", - "causes": [], - "retryAfterSeconds": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.StatusDetails.name: - -name - (`string `_) The name attribute of the resource associated with the status StatusReason - (when there is a single name which can be described). - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.StatusDetails.group: - -group - (`string `_) The group attribute of the resource associated with the status StatusReason. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.StatusDetails.kind: - -kind - (`string `_) The kind attribute of the resource associated with the status StatusReason. - On some operations may differ from the requested resource Kind. - More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.StatusDetails.uid: - -uid - (`string `_) UID of the resource. - (when there is a single resource which can be described). - More info: http://kubernetes.io/docs/user-guide/identifiers#uids - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.StatusDetails.causes: - -causes - (:ref:`k8s.io.apimachinery.pkg.apis.meta.v1.StatusCause `) The Causes array includes more details associated with the StatusReason - failure. Not all StatusReasons may provide detailed causes. - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.StatusDetails.retryAfterSeconds: - -retryAfterSeconds - (`int32 `_) If specified, the time in seconds before the operation should be retried. Some errors may indicate - the client must take an alternate action - for those errors this field may indicate how long to wait - before taking the alternate action. - +optional - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.Time: - -k8s.io.apimachinery.pkg.apis.meta.v1.Time ------------------------------------------ - -`[k8s.io.apimachinery.pkg.apis.meta.v1.Time proto] `_ - -Time is a wrapper around time.Time which supports correct -marshaling to YAML and JSON. Wrappers are provided for many -of the factory methods that the time package offers. - -+protobuf.options.marshal=false -+protobuf.as=Timestamp -+protobuf.options.(gogoproto.goproto_stringer)=false - -.. code-block:: json - - { - "seconds": "...", - "nanos": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.Time.seconds: - -seconds - (`int64 `_) Represents seconds of UTC time since Unix epoch - 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to - 9999-12-31T23:59:59Z inclusive. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.Time.nanos: - -nanos - (`int32 `_) Non-negative fractions of a second at nanosecond resolution. Negative - second values with fractions must still have non-negative nanos values - that count forward in time. Must be from 0 to 999,999,999 - inclusive. This field may be limited in precision depending on context. - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.Timestamp: - -k8s.io.apimachinery.pkg.apis.meta.v1.Timestamp ----------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.Timestamp proto] `_ - -Timestamp is a struct that is equivalent to Time, but intended for -protobuf marshalling/unmarshalling. It is generated into a serialization -that matches Time. Do not use in Go structs. - -.. code-block:: json - - { - "seconds": "...", - "nanos": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.Timestamp.seconds: - -seconds - (`int64 `_) Represents seconds of UTC time since Unix epoch - 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to - 9999-12-31T23:59:59Z inclusive. - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.Timestamp.nanos: - -nanos - (`int32 `_) Non-negative fractions of a second at nanosecond resolution. Negative - second values with fractions must still have non-negative nanos values - that count forward in time. Must be from 0 to 999,999,999 - inclusive. This field may be limited in precision depending on context. - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.TypeMeta: - -k8s.io.apimachinery.pkg.apis.meta.v1.TypeMeta ---------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.TypeMeta proto] `_ - -TypeMeta describes an individual object in an API response or request -with strings representing the type of the object and its API schema version. -Structures that are versioned or persisted should inline TypeMeta. - -+k8s:deepcopy-gen=false - -.. code-block:: json - - { - "kind": "...", - "apiVersion": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.TypeMeta.kind: - -kind - (`string `_) 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/api-conventions.md#types-kinds - +optional - - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.TypeMeta.apiVersion: - -apiVersion - (`string `_) 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/api-conventions.md#resources - +optional - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.UpdateOptions: - -k8s.io.apimachinery.pkg.apis.meta.v1.UpdateOptions --------------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.UpdateOptions proto] `_ - -UpdateOptions may be provided when updating an API object. -All fields in UpdateOptions should also be present in PatchOptions. - -.. code-block:: json - - { - "dryRun": [] - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.UpdateOptions.dryRun: - -dryRun - (`string `_) When present, indicates that modifications should not be - persisted. An invalid or unrecognized dryRun directive will - result in an error response and no further processing of the - request. Valid values are: - - All: all dry run stages will be processed - +optional - - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.Verbs: - -k8s.io.apimachinery.pkg.apis.meta.v1.Verbs ------------------------------------------- - -`[k8s.io.apimachinery.pkg.apis.meta.v1.Verbs proto] `_ - -Verbs masks the value so protobuf can generate - -+protobuf.nullable=true -+protobuf.options.(gogoproto.goproto_stringer)=false - -.. code-block:: json - - { - "items": [] - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.Verbs.items: - -items - (`string `_) - - - -.. _api_msg_k8s.io.apimachinery.pkg.apis.meta.v1.WatchEvent: - -k8s.io.apimachinery.pkg.apis.meta.v1.WatchEvent ------------------------------------------------ - -`[k8s.io.apimachinery.pkg.apis.meta.v1.WatchEvent proto] `_ - -Event represents a single event to a watched resource. - -+protobuf=true -+k8s:deepcopy-gen=true -+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object - -.. code-block:: json - - { - "type": "...", - "object": "{...}" - } - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.WatchEvent.type: - -type - (`string `_) - -.. _api_field_k8s.io.apimachinery.pkg.apis.meta.v1.WatchEvent.object: - -object - (:ref:`k8s.io.apimachinery.pkg.runtime.RawExtension `) Object is: - * If Type is Added or Modified: the new state of the object. - * If Type is Deleted: the state of the object immediately before deletion. - * If Type is Error: *Status is recommended; other types may make sense - depending on context. - - - diff --git a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/apis/meta/v1/index.rst b/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/apis/meta/v1/index.rst deleted file mode 100644 index 23613b6ea7..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/apis/meta/v1/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -v1 -== - -.. toctree:: - :maxdepth: 1 - :caption: v1 - :name: v1toc - - generated.proto diff --git a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/index.rst b/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/index.rst deleted file mode 100644 index dd16908831..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -pkg -=== - -.. toctree:: - :maxdepth: 1 - :caption: pkg - :name: pkgtoc - - api/index - apis/index - runtime/index - util/index diff --git a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/runtime/generated.proto.rst b/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/runtime/generated.proto.rst deleted file mode 100644 index 91a580bdcd..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/runtime/generated.proto.rst +++ /dev/null @@ -1,188 +0,0 @@ -.. _api_file_k8s.io/apimachinery/pkg/runtime/generated.proto: - -generated.proto -=============================================== - - -opyright The Kubernetes Authors. - -icensed under the Apache License, Version 2.0 (the "License"); -ou may not use this file except in compliance with the License. -ou may obtain a copy of the License at - -ttp://www.apache.org/licenses/LICENSE-2.0 - -nless required by applicable law or agreed to in writing, software -istributed under the License is distributed on an "AS IS" BASIS, -ITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -ee the License for the specific language governing permissions and -imitations under the License. -This file was autogenerated by go-to-protobuf. Do not edit it manually! - -.. _api_msg_k8s.io.apimachinery.pkg.runtime.RawExtension: - -k8s.io.apimachinery.pkg.runtime.RawExtension --------------------------------------------- - -`[k8s.io.apimachinery.pkg.runtime.RawExtension proto] `_ - -RawExtension is used to hold extensions in external versions. - -To use this, make a field which has RawExtension as its type in your external, versioned -struct, and Object in your internal struct. You also need to register your -various plugin types. - -// Internal package: -type MyAPIObject struct { - runtime.TypeMeta `json:",inline"` - MyPlugin runtime.Object `json:"myPlugin"` -} -type PluginA struct { - AOption string `json:"aOption"` -} - -// External package: -type MyAPIObject struct { - runtime.TypeMeta `json:",inline"` - MyPlugin runtime.RawExtension `json:"myPlugin"` -} -type PluginA struct { - AOption string `json:"aOption"` -} - -// On the wire, the JSON will look something like this: -{ - "kind":"MyAPIObject", - "apiVersion":"v1", - "myPlugin": { - "kind":"PluginA", - "aOption":"foo", - }, -} - -So what happens? Decode first uses json or yaml to unmarshal the serialized data into -your external MyAPIObject. That causes the raw JSON to be stored, but not unpacked. -The next step is to copy (using pkg/conversion) into the internal struct. The runtime -package's DefaultScheme has conversion functions installed which will unpack the -JSON stored in RawExtension, turning it into the correct object type, and storing it -in the Object. (TODO: In the case where the object is of an unknown type, a -runtime.Unknown object will be created and stored.) - -+k8s:deepcopy-gen=true -+protobuf=true -+k8s:openapi-gen=true - -.. code-block:: json - - { - "raw": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.runtime.RawExtension.raw: - -raw - (`bytes `_) Raw is the underlying serialization of this object. - - TODO: Determine how to detect ContentType and ContentEncoding of 'Raw' data. - - - - -.. _api_msg_k8s.io.apimachinery.pkg.runtime.TypeMeta: - -k8s.io.apimachinery.pkg.runtime.TypeMeta ----------------------------------------- - -`[k8s.io.apimachinery.pkg.runtime.TypeMeta proto] `_ - -TypeMeta is shared by all top level objects. The proper way to use it is to inline it in your type, -like this: -type MyAwesomeAPIObject struct { - runtime.TypeMeta `json:",inline"` - ... // other fields -} -func (obj *MyAwesomeAPIObject) SetGroupVersionKind(gvk *metav1.GroupVersionKind) { metav1.UpdateTypeMeta(obj,gvk) }; GroupVersionKind() *GroupVersionKind - -TypeMeta is provided here for convenience. You may use it directly from this package or define -your own with the same fields. - -+k8s:deepcopy-gen=false -+protobuf=true -+k8s:openapi-gen=true - -.. code-block:: json - - { - "apiVersion": "...", - "kind": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.runtime.TypeMeta.apiVersion: - -apiVersion - (`string `_) +optional - - -.. _api_field_k8s.io.apimachinery.pkg.runtime.TypeMeta.kind: - -kind - (`string `_) +optional - - - - -.. _api_msg_k8s.io.apimachinery.pkg.runtime.Unknown: - -k8s.io.apimachinery.pkg.runtime.Unknown ---------------------------------------- - -`[k8s.io.apimachinery.pkg.runtime.Unknown proto] `_ - -Unknown allows api objects with unknown types to be passed-through. This can be used -to deal with the API objects from a plug-in. Unknown objects still have functioning -TypeMeta features-- kind, version, etc. -TODO: Make this object have easy access to field based accessors and settors for -metadata and field mutatation. - -+k8s:deepcopy-gen=true -+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object -+protobuf=true -+k8s:openapi-gen=true - -.. code-block:: json - - { - "typeMeta": "{...}", - "raw": "...", - "contentEncoding": "...", - "contentType": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.runtime.Unknown.typeMeta: - -typeMeta - (:ref:`k8s.io.apimachinery.pkg.runtime.TypeMeta `) - -.. _api_field_k8s.io.apimachinery.pkg.runtime.Unknown.raw: - -raw - (`bytes `_) Raw will hold the complete serialized object which couldn't be matched - with a registered type. Most likely, nothing should be done with this - except for passing it through the system. - - -.. _api_field_k8s.io.apimachinery.pkg.runtime.Unknown.contentEncoding: - -contentEncoding - (`string `_) ContentEncoding is encoding used to encode 'Raw' data. - Unspecified means no encoding. - - -.. _api_field_k8s.io.apimachinery.pkg.runtime.Unknown.contentType: - -contentType - (`string `_) ContentType is serialization method used to serialize 'Raw'. - Unspecified means ContentTypeJSON. - - - diff --git a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/runtime/index.rst b/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/runtime/index.rst deleted file mode 100644 index d34b77d824..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/runtime/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -runtime -======= - -.. toctree:: - :maxdepth: 1 - :caption: runtime - :name: runtimetoc - - schema/index - generated.proto diff --git a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/runtime/schema/generated.proto.rst b/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/runtime/schema/generated.proto.rst deleted file mode 100644 index f3dd8a421d..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/runtime/schema/generated.proto.rst +++ /dev/null @@ -1,21 +0,0 @@ -.. _api_file_k8s.io/apimachinery/pkg/runtime/schema/generated.proto: - -generated.proto -====================================================== - - -opyright The Kubernetes Authors. - -icensed under the Apache License, Version 2.0 (the "License"); -ou may not use this file except in compliance with the License. -ou may obtain a copy of the License at - -ttp://www.apache.org/licenses/LICENSE-2.0 - -nless required by applicable law or agreed to in writing, software -istributed under the License is distributed on an "AS IS" BASIS, -ITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -ee the License for the specific language governing permissions and -imitations under the License. -This file was autogenerated by go-to-protobuf. Do not edit it manually! - diff --git a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/runtime/schema/index.rst b/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/runtime/schema/index.rst deleted file mode 100644 index 29e08134ca..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/runtime/schema/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -schema -====== - -.. toctree:: - :maxdepth: 1 - :caption: schema - :name: schematoc - - generated.proto diff --git a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/util/index.rst b/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/util/index.rst deleted file mode 100644 index 1711856363..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/util/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -util -==== - -.. toctree:: - :maxdepth: 1 - :caption: util - :name: utiltoc - - intstr/index diff --git a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/util/intstr/generated.proto.rst b/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/util/intstr/generated.proto.rst deleted file mode 100644 index ef244109bd..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/util/intstr/generated.proto.rst +++ /dev/null @@ -1,62 +0,0 @@ -.. _api_file_k8s.io/apimachinery/pkg/util/intstr/generated.proto: - -generated.proto -=================================================== - - -opyright The Kubernetes Authors. - -icensed under the Apache License, Version 2.0 (the "License"); -ou may not use this file except in compliance with the License. -ou may obtain a copy of the License at - -ttp://www.apache.org/licenses/LICENSE-2.0 - -nless required by applicable law or agreed to in writing, software -istributed under the License is distributed on an "AS IS" BASIS, -ITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -ee the License for the specific language governing permissions and -imitations under the License. -This file was autogenerated by go-to-protobuf. Do not edit it manually! - -.. _api_msg_k8s.io.apimachinery.pkg.util.intstr.IntOrString: - -k8s.io.apimachinery.pkg.util.intstr.IntOrString ------------------------------------------------ - -`[k8s.io.apimachinery.pkg.util.intstr.IntOrString proto] `_ - -IntOrString is a type that can hold an int32 or a string. When used in -JSON or YAML marshalling and unmarshalling, it produces or consumes the -inner type. This allows you to have, for example, a JSON field that can -accept a name or number. -TODO: Rename to Int32OrString - -+protobuf=true -+protobuf.options.(gogoproto.goproto_stringer)=false -+k8s:openapi-gen=true - -.. code-block:: json - - { - "type": "...", - "intVal": "...", - "strVal": "..." - } - -.. _api_field_k8s.io.apimachinery.pkg.util.intstr.IntOrString.type: - -type - (`int64 `_) - -.. _api_field_k8s.io.apimachinery.pkg.util.intstr.IntOrString.intVal: - -intVal - (`int32 `_) - -.. _api_field_k8s.io.apimachinery.pkg.util.intstr.IntOrString.strVal: - -strVal - (`string `_) - - diff --git a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/util/intstr/index.rst b/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/util/intstr/index.rst deleted file mode 100644 index b9e34d47f4..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/apimachinery/pkg/util/intstr/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -intstr -====== - -.. toctree:: - :maxdepth: 1 - :caption: intstr - :name: intstrtoc - - generated.proto diff --git a/flyteidl/gen/pb-protodoc/k8s.io/index.rst b/flyteidl/gen/pb-protodoc/k8s.io/index.rst deleted file mode 100644 index 810e21b67d..0000000000 --- a/flyteidl/gen/pb-protodoc/k8s.io/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -k8s.io -====== - -.. toctree:: - :maxdepth: 1 - :caption: k8s.io - :name: k8s.iotoc - - api/index - apimachinery/index diff --git a/flyteidl/gen/pb-protodoc/protoc-gen-swagger/index.rst b/flyteidl/gen/pb-protodoc/protoc-gen-swagger/index.rst deleted file mode 100644 index d6eb056fc3..0000000000 --- a/flyteidl/gen/pb-protodoc/protoc-gen-swagger/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -protoc-gen-swagger -================== - -.. toctree:: - :maxdepth: 1 - :caption: protoc-gen-swagger - :name: protoc-gen-swaggertoc - - options/index diff --git a/flyteidl/gen/pb-protodoc/protoc-gen-swagger/options/annotations.proto.rst b/flyteidl/gen/pb-protodoc/protoc-gen-swagger/options/annotations.proto.rst deleted file mode 100644 index 1c39b834b4..0000000000 --- a/flyteidl/gen/pb-protodoc/protoc-gen-swagger/options/annotations.proto.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. _api_file_protoc-gen-swagger/options/annotations.proto: - -annotations.proto -============================================ - diff --git a/flyteidl/gen/pb-protodoc/protoc-gen-swagger/options/index.rst b/flyteidl/gen/pb-protodoc/protoc-gen-swagger/options/index.rst deleted file mode 100644 index b1ce35c59d..0000000000 --- a/flyteidl/gen/pb-protodoc/protoc-gen-swagger/options/index.rst +++ /dev/null @@ -1,10 +0,0 @@ -options -======= - -.. toctree:: - :maxdepth: 1 - :caption: options - :name: optionstoc - - annotations.proto - openapiv2.proto diff --git a/flyteidl/gen/pb-protodoc/protoc-gen-swagger/options/openapiv2.proto.rst b/flyteidl/gen/pb-protodoc/protoc-gen-swagger/options/openapiv2.proto.rst deleted file mode 100644 index 9d5eef9b0b..0000000000 --- a/flyteidl/gen/pb-protodoc/protoc-gen-swagger/options/openapiv2.proto.rst +++ /dev/null @@ -1,1000 +0,0 @@ -.. _api_file_protoc-gen-swagger/options/openapiv2.proto: - -openapiv2.proto -========================================== - -.. _api_msg_grpc.gateway.protoc_gen_swagger.options.Swagger: - -grpc.gateway.protoc_gen_swagger.options.Swagger ------------------------------------------------ - -`[grpc.gateway.protoc_gen_swagger.options.Swagger proto] `_ - -`Swagger` is a representation of OpenAPI v2 specification's Swagger object. - -See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#swaggerObject - -TODO(ivucica): document fields - -.. code-block:: json - - { - "swagger": "...", - "info": "{...}", - "host": "...", - "base_path": "...", - "schemes": [], - "consumes": [], - "produces": [], - "responses": "{...}", - "security_definitions": "{...}", - "security": [], - "external_docs": "{...}" - } - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Swagger.swagger: - -swagger - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Swagger.info: - -info - (:ref:`grpc.gateway.protoc_gen_swagger.options.Info `) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Swagger.host: - -host - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Swagger.base_path: - -base_path - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Swagger.schemes: - -schemes - (:ref:`grpc.gateway.protoc_gen_swagger.options.Swagger.SwaggerScheme `) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Swagger.consumes: - -consumes - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Swagger.produces: - -produces - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Swagger.responses: - -responses - (map<`string `_, :ref:`grpc.gateway.protoc_gen_swagger.options.Response `>) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Swagger.security_definitions: - -security_definitions - (:ref:`grpc.gateway.protoc_gen_swagger.options.SecurityDefinitions `) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Swagger.security: - -security - (:ref:`grpc.gateway.protoc_gen_swagger.options.SecurityRequirement `) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Swagger.external_docs: - -external_docs - (:ref:`grpc.gateway.protoc_gen_swagger.options.ExternalDocumentation `) - - -.. _api_enum_grpc.gateway.protoc_gen_swagger.options.Swagger.SwaggerScheme: - -Enum grpc.gateway.protoc_gen_swagger.options.Swagger.SwaggerScheme ------------------------------------------------------------------- - -`[grpc.gateway.protoc_gen_swagger.options.Swagger.SwaggerScheme proto] `_ - - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.Swagger.SwaggerScheme.UNKNOWN: - -UNKNOWN - *(DEFAULT)* ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.Swagger.SwaggerScheme.HTTP: - -HTTP - ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.Swagger.SwaggerScheme.HTTPS: - -HTTPS - ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.Swagger.SwaggerScheme.WS: - -WS - ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.Swagger.SwaggerScheme.WSS: - -WSS - ⁣ - - -.. _api_msg_grpc.gateway.protoc_gen_swagger.options.Operation: - -grpc.gateway.protoc_gen_swagger.options.Operation -------------------------------------------------- - -`[grpc.gateway.protoc_gen_swagger.options.Operation proto] `_ - -`Operation` is a representation of OpenAPI v2 specification's Operation object. - -See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#operationObject - -TODO(ivucica): document fields - -.. code-block:: json - - { - "tags": [], - "summary": "...", - "description": "...", - "external_docs": "{...}", - "operation_id": "...", - "consumes": [], - "produces": [], - "responses": "{...}", - "schemes": [], - "deprecated": "...", - "security": [] - } - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Operation.tags: - -tags - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Operation.summary: - -summary - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Operation.description: - -description - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Operation.external_docs: - -external_docs - (:ref:`grpc.gateway.protoc_gen_swagger.options.ExternalDocumentation `) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Operation.operation_id: - -operation_id - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Operation.consumes: - -consumes - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Operation.produces: - -produces - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Operation.responses: - -responses - (map<`string `_, :ref:`grpc.gateway.protoc_gen_swagger.options.Response `>) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Operation.schemes: - -schemes - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Operation.deprecated: - -deprecated - (`bool `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Operation.security: - -security - (:ref:`grpc.gateway.protoc_gen_swagger.options.SecurityRequirement `) - - - -.. _api_msg_grpc.gateway.protoc_gen_swagger.options.Response: - -grpc.gateway.protoc_gen_swagger.options.Response ------------------------------------------------- - -`[grpc.gateway.protoc_gen_swagger.options.Response proto] `_ - -`Response` is a representation of OpenAPI v2 specification's Response object. - -See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#responseObject - - -.. code-block:: json - - { - "description": "...", - "schema": "{...}" - } - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Response.description: - -description - (`string `_) `Description` is a short description of the response. - GFM syntax can be used for rich text representation. - - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Response.schema: - -schema - (:ref:`grpc.gateway.protoc_gen_swagger.options.Schema `) `Schema` optionally defines the structure of the response. - If `Schema` is not provided, it means there is no content to the response. - - - - -.. _api_msg_grpc.gateway.protoc_gen_swagger.options.Info: - -grpc.gateway.protoc_gen_swagger.options.Info --------------------------------------------- - -`[grpc.gateway.protoc_gen_swagger.options.Info proto] `_ - -`Info` is a representation of OpenAPI v2 specification's Info object. - -See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#infoObject - -TODO(ivucica): document fields - -.. code-block:: json - - { - "title": "...", - "description": "...", - "terms_of_service": "...", - "contact": "{...}", - "license": "{...}", - "version": "..." - } - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Info.title: - -title - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Info.description: - -description - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Info.terms_of_service: - -terms_of_service - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Info.contact: - -contact - (:ref:`grpc.gateway.protoc_gen_swagger.options.Contact `) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Info.license: - -license - (:ref:`grpc.gateway.protoc_gen_swagger.options.License `) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Info.version: - -version - (`string `_) - - - -.. _api_msg_grpc.gateway.protoc_gen_swagger.options.Contact: - -grpc.gateway.protoc_gen_swagger.options.Contact ------------------------------------------------ - -`[grpc.gateway.protoc_gen_swagger.options.Contact proto] `_ - -`Contact` is a representation of OpenAPI v2 specification's Contact object. - -See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#contactObject - -TODO(ivucica): document fields - -.. code-block:: json - - { - "name": "...", - "url": "...", - "email": "..." - } - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Contact.name: - -name - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Contact.url: - -url - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Contact.email: - -email - (`string `_) - - - -.. _api_msg_grpc.gateway.protoc_gen_swagger.options.License: - -grpc.gateway.protoc_gen_swagger.options.License ------------------------------------------------ - -`[grpc.gateway.protoc_gen_swagger.options.License proto] `_ - -`License` is a representation of OpenAPI v2 specification's License object. - -See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#licenseObject - - -.. code-block:: json - - { - "name": "...", - "url": "..." - } - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.License.name: - -name - (`string `_) Required. The license name used for the API. - - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.License.url: - -url - (`string `_) A URL to the license used for the API. - - - - -.. _api_msg_grpc.gateway.protoc_gen_swagger.options.ExternalDocumentation: - -grpc.gateway.protoc_gen_swagger.options.ExternalDocumentation -------------------------------------------------------------- - -`[grpc.gateway.protoc_gen_swagger.options.ExternalDocumentation proto] `_ - -`ExternalDocumentation` is a representation of OpenAPI v2 specification's -ExternalDocumentation object. - -See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#externalDocumentationObject - -TODO(ivucica): document fields - -.. code-block:: json - - { - "description": "...", - "url": "..." - } - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.ExternalDocumentation.description: - -description - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.ExternalDocumentation.url: - -url - (`string `_) - - - -.. _api_msg_grpc.gateway.protoc_gen_swagger.options.Schema: - -grpc.gateway.protoc_gen_swagger.options.Schema ----------------------------------------------- - -`[grpc.gateway.protoc_gen_swagger.options.Schema proto] `_ - -`Schema` is a representation of OpenAPI v2 specification's Schema object. - -See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject - -TODO(ivucica): document fields - -.. code-block:: json - - { - "json_schema": "{...}", - "discriminator": "...", - "read_only": "...", - "external_docs": "{...}", - "example": "{...}" - } - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Schema.json_schema: - -json_schema - (:ref:`grpc.gateway.protoc_gen_swagger.options.JSONSchema `) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Schema.discriminator: - -discriminator - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Schema.read_only: - -read_only - (`bool `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Schema.external_docs: - -external_docs - (:ref:`grpc.gateway.protoc_gen_swagger.options.ExternalDocumentation `) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Schema.example: - -example - (:ref:`google.protobuf.Any `) - - - -.. _api_msg_grpc.gateway.protoc_gen_swagger.options.JSONSchema: - -grpc.gateway.protoc_gen_swagger.options.JSONSchema --------------------------------------------------- - -`[grpc.gateway.protoc_gen_swagger.options.JSONSchema proto] `_ - -`JSONSchema` represents properties from JSON Schema taken, and as used, in -the OpenAPI v2 spec. - -This includes changes made by OpenAPI v2. - -See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject - -See also: https://cswr.github.io/JsonSchema/spec/basic_types/, -https://github.com/json-schema-org/json-schema-spec/blob/master/schema.json - -TODO(ivucica): document fields - -.. code-block:: json - - { - "ref": "...", - "title": "...", - "description": "...", - "default": "...", - "read_only": "...", - "multiple_of": "...", - "maximum": "...", - "exclusive_maximum": "...", - "minimum": "...", - "exclusive_minimum": "...", - "max_length": "...", - "min_length": "...", - "pattern": "...", - "max_items": "...", - "min_items": "...", - "unique_items": "...", - "max_properties": "...", - "min_properties": "...", - "required": [], - "array": [], - "type": [] - } - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.ref: - -ref - (`string `_) Ref is used to define an external reference to include in the message. - This could be a fully qualified proto message reference, and that type must be imported - into the protofile. If no message is identified, the Ref will be used verbatim in - the output. - For example: - `ref: ".google.protobuf.Timestamp"`. - - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.title: - -title - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.description: - -description - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.default: - -default - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.read_only: - -read_only - (`bool `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.multiple_of: - -multiple_of - (`double `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.maximum: - -maximum - (`double `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.exclusive_maximum: - -exclusive_maximum - (`bool `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.minimum: - -minimum - (`double `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.exclusive_minimum: - -exclusive_minimum - (`bool `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.max_length: - -max_length - (`uint64 `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.min_length: - -min_length - (`uint64 `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.pattern: - -pattern - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.max_items: - -max_items - (`uint64 `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.min_items: - -min_items - (`uint64 `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.unique_items: - -unique_items - (`bool `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.max_properties: - -max_properties - (`uint64 `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.min_properties: - -min_properties - (`uint64 `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.required: - -required - (`string `_) - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.array: - -array - (`string `_) Items in 'array' must be unique. - - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.JSONSchema.type: - -type - (:ref:`grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes `) - - -.. _api_enum_grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes: - -Enum grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes ------------------------------------------------------------------------------ - -`[grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes proto] `_ - - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes.UNKNOWN: - -UNKNOWN - *(DEFAULT)* ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes.ARRAY: - -ARRAY - ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes.BOOLEAN: - -BOOLEAN - ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes.INTEGER: - -INTEGER - ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes.NULL: - -NULL - ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes.NUMBER: - -NUMBER - ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes.OBJECT: - -OBJECT - ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.JSONSchema.JSONSchemaSimpleTypes.STRING: - -STRING - ⁣ - - -.. _api_msg_grpc.gateway.protoc_gen_swagger.options.Tag: - -grpc.gateway.protoc_gen_swagger.options.Tag -------------------------------------------- - -`[grpc.gateway.protoc_gen_swagger.options.Tag proto] `_ - -`Tag` is a representation of OpenAPI v2 specification's Tag object. - -See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#tagObject - -TODO(ivucica): document fields - -.. code-block:: json - - { - "description": "...", - "external_docs": "{...}" - } - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Tag.description: - -description - (`string `_) TODO(ivucica): Description should be extracted from comments on the proto - service object. - - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Tag.external_docs: - -external_docs - (:ref:`grpc.gateway.protoc_gen_swagger.options.ExternalDocumentation `) - - - -.. _api_msg_grpc.gateway.protoc_gen_swagger.options.SecurityDefinitions: - -grpc.gateway.protoc_gen_swagger.options.SecurityDefinitions ------------------------------------------------------------ - -`[grpc.gateway.protoc_gen_swagger.options.SecurityDefinitions proto] `_ - -`SecurityDefinitions` is a representation of OpenAPI v2 specification's -Security Definitions object. - -See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityDefinitionsObject - -A declaration of the security schemes available to be used in the -specification. This does not enforce the security schemes on the operations -and only serves to provide the relevant details for each scheme. - -.. code-block:: json - - { - "security": "{...}" - } - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.SecurityDefinitions.security: - -security - (map<`string `_, :ref:`grpc.gateway.protoc_gen_swagger.options.SecurityScheme `>) A single security scheme definition, mapping a "name" to the scheme it defines. - - - - -.. _api_msg_grpc.gateway.protoc_gen_swagger.options.SecurityScheme: - -grpc.gateway.protoc_gen_swagger.options.SecurityScheme ------------------------------------------------------- - -`[grpc.gateway.protoc_gen_swagger.options.SecurityScheme proto] `_ - -`SecurityScheme` is a representation of OpenAPI v2 specification's -Security Scheme object. - -See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securitySchemeObject - -Allows the definition of a security scheme that can be used by the -operations. Supported schemes are basic authentication, an API key (either as -a header or as a query parameter) and OAuth2's common flows (implicit, -password, application and access code). - -.. code-block:: json - - { - "type": "...", - "description": "...", - "name": "...", - "in": "...", - "flow": "...", - "authorization_url": "...", - "token_url": "...", - "scopes": "{...}" - } - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.type: - -type - (:ref:`grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Type `) Required. The type of the security scheme. Valid values are "basic", - "apiKey" or "oauth2". - - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.description: - -description - (`string `_) A short description for security scheme. - - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.name: - -name - (`string `_) Required. The name of the header or query parameter to be used. - - Valid for apiKey. - - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.in: - -in - (:ref:`grpc.gateway.protoc_gen_swagger.options.SecurityScheme.In `) Required. The location of the API key. Valid values are "query" or "header". - - Valid for apiKey. - - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.flow: - -flow - (:ref:`grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Flow `) Required. The flow used by the OAuth2 security scheme. Valid values are - "implicit", "password", "application" or "accessCode". - - Valid for oauth2. - - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.authorization_url: - -authorization_url - (`string `_) Required. The authorization URL to be used for this flow. This SHOULD be in - the form of a URL. - - Valid for oauth2/implicit and oauth2/accessCode. - - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.token_url: - -token_url - (`string `_) Required. The token URL to be used for this flow. This SHOULD be in the - form of a URL. - - Valid for oauth2/password, oauth2/application and oauth2/accessCode. - - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.scopes: - -scopes - (:ref:`grpc.gateway.protoc_gen_swagger.options.Scopes `) Required. The available scopes for the OAuth2 security scheme. - - Valid for oauth2. - - - -.. _api_enum_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Type: - -Enum grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Type ----------------------------------------------------------------- - -`[grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Type proto] `_ - -Required. The type of the security scheme. Valid values are "basic", -"apiKey" or "oauth2". - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Type.TYPE_INVALID: - -TYPE_INVALID - *(DEFAULT)* ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Type.TYPE_BASIC: - -TYPE_BASIC - ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Type.TYPE_API_KEY: - -TYPE_API_KEY - ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Type.TYPE_OAUTH2: - -TYPE_OAUTH2 - ⁣ - - -.. _api_enum_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.In: - -Enum grpc.gateway.protoc_gen_swagger.options.SecurityScheme.In --------------------------------------------------------------- - -`[grpc.gateway.protoc_gen_swagger.options.SecurityScheme.In proto] `_ - -Required. The location of the API key. Valid values are "query" or "header". - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.In.IN_INVALID: - -IN_INVALID - *(DEFAULT)* ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.In.IN_QUERY: - -IN_QUERY - ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.In.IN_HEADER: - -IN_HEADER - ⁣ - - -.. _api_enum_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Flow: - -Enum grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Flow ----------------------------------------------------------------- - -`[grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Flow proto] `_ - -Required. The flow used by the OAuth2 security scheme. Valid values are -"implicit", "password", "application" or "accessCode". - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Flow.FLOW_INVALID: - -FLOW_INVALID - *(DEFAULT)* ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Flow.FLOW_IMPLICIT: - -FLOW_IMPLICIT - ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Flow.FLOW_PASSWORD: - -FLOW_PASSWORD - ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Flow.FLOW_APPLICATION: - -FLOW_APPLICATION - ⁣ - -.. _api_enum_value_grpc.gateway.protoc_gen_swagger.options.SecurityScheme.Flow.FLOW_ACCESS_CODE: - -FLOW_ACCESS_CODE - ⁣ - - -.. _api_msg_grpc.gateway.protoc_gen_swagger.options.SecurityRequirement: - -grpc.gateway.protoc_gen_swagger.options.SecurityRequirement ------------------------------------------------------------ - -`[grpc.gateway.protoc_gen_swagger.options.SecurityRequirement proto] `_ - -`SecurityRequirement` is a representation of OpenAPI v2 specification's -Security Requirement object. - -See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#securityRequirementObject - -Lists the required security schemes to execute this operation. The object can -have multiple security schemes declared in it which are all required (that -is, there is a logical AND between the schemes). - -The name used for each property MUST correspond to a security scheme -declared in the Security Definitions. - -.. code-block:: json - - { - "security_requirement": "{...}" - } - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.SecurityRequirement.security_requirement: - -security_requirement - (map<`string `_, :ref:`grpc.gateway.protoc_gen_swagger.options.SecurityRequirement.SecurityRequirementValue `>) Each name must correspond to a security scheme which is declared in - the Security Definitions. If the security scheme is of type "oauth2", - then the value is a list of scope names required for the execution. - For other security scheme types, the array MUST be empty. - - -.. _api_msg_grpc.gateway.protoc_gen_swagger.options.SecurityRequirement.SecurityRequirementValue: - -grpc.gateway.protoc_gen_swagger.options.SecurityRequirement.SecurityRequirementValue ------------------------------------------------------------------------------------- - -`[grpc.gateway.protoc_gen_swagger.options.SecurityRequirement.SecurityRequirementValue proto] `_ - -If the security scheme is of type "oauth2", then the value is a list of -scope names required for the execution. For other security scheme types, -the array MUST be empty. - -.. code-block:: json - - { - "scope": [] - } - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.SecurityRequirement.SecurityRequirementValue.scope: - -scope - (`string `_) - - - - - -.. _api_msg_grpc.gateway.protoc_gen_swagger.options.Scopes: - -grpc.gateway.protoc_gen_swagger.options.Scopes ----------------------------------------------- - -`[grpc.gateway.protoc_gen_swagger.options.Scopes proto] `_ - -`Scopes` is a representation of OpenAPI v2 specification's Scopes object. - -See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#scopesObject - -Lists the available scopes for an OAuth2 security scheme. - -.. code-block:: json - - { - "scope": "{...}" - } - -.. _api_field_grpc.gateway.protoc_gen_swagger.options.Scopes.scope: - -scope - (map<`string `_, `string `_>) Maps between a name of a scope to a short description of it (as the value - of the property). - - - diff --git a/flyteidl/generate_protos.sh b/flyteidl/generate_protos.sh index e52605cf61..a0834c0341 100755 --- a/flyteidl/generate_protos.sh +++ b/flyteidl/generate_protos.sh @@ -24,12 +24,48 @@ do done # Docs generated -docker run --rm -u $(id -u):$(id -g) -e REPO_BLOB_SHA=master -e PROJECT_ANNOTATION_PREFIX=flyte.interface -v $DIR:/defs $LYFT_IMAGE -i ./protos -d protos/flyteidl/service -l protodoc -docker run --rm -u $(id -u):$(id -g) -e REPO_BLOB_SHA=master -e PROJECT_ANNOTATION_PREFIX=flyte.interface -v $DIR:/defs $LYFT_IMAGE -i ./protos -d protos/flyteidl/admin -l protodoc -docker run --rm -u $(id -u):$(id -g) -e REPO_BLOB_SHA=master -e PROJECT_ANNOTATION_PREFIX=flyte.interface -v $DIR:/defs $LYFT_IMAGE -i ./protos -d protos/flyteidl/core -l protodoc -docker run --rm -u $(id -u):$(id -g) -e REPO_BLOB_SHA=master -e PROJECT_ANNOTATION_PREFIX=flyte.interface -v $DIR:/defs $LYFT_IMAGE -i ./protos -d protos/flyteidl/event -l protodoc -docker run --rm -u $(id -u):$(id -g) -e REPO_BLOB_SHA=master -e PROJECT_ANNOTATION_PREFIX=flyte.interface -v $DIR:/defs $LYFT_IMAGE -i ./protos -d protos/flyteidl/plugins -l protodoc -docker run --rm -u $(id -u):$(id -g) -e REPO_BLOB_SHA=master -e PROJECT_ANNOTATION_PREFIX=flyte.interface -v $DIR:/defs $LYFT_IMAGE -i ./protos -d protos/flyteidl/datacatalog -l protodoc + +# Get list of proto files in core directory +core_proto_files=`ls protos/flyteidl/core/*.proto |xargs` +# Remove any currently generated file +ls -d protos/docs/core/* | grep -v index.rst | xargs rm +# Use the list to generate the MD files required for sphinx conversion +docker run --rm -v $(pwd)/protos/docs/core:/out -v $(pwd)/protos:/protos pseudomuto/protoc-gen-doc --doc_opt=markdown,core.md -I=protos `echo $core_proto_files` + +# Get list of proto files in admin directory +admin_proto_files=`ls protos/flyteidl/admin/*.proto |xargs` +# Remove any currently generated file +ls -d protos/docs/admin/* | grep -v index.rst | xargs rm +# Use the list to generate the MD files required for sphinx conversion +docker run --rm -v $(pwd)/protos/docs/admin:/out -v $(pwd)/protos:/protos pseudomuto/protoc-gen-doc --doc_opt=markdown,admin.md -I=protos `echo $admin_proto_files` + +# Get list of proto files in datacatlog directory +datacatalog_proto_files=`ls protos/flyteidl/datacatalog/*.proto |xargs` +# Remove any currently generated file +ls -d protos/docs/datacatalog/* | grep -v index.rst | xargs rm +# Use the list to generate the MD files required for sphinx conversion +docker run --rm -v $(pwd)/protos/docs/datacatalog:/out -v $(pwd)/protos:/protos pseudomuto/protoc-gen-doc --doc_opt=markdown,datacatalog.md -I=protos `echo $datacatalog_proto_files` + +# Get list of proto files in event directory +event_proto_files=`ls protos/flyteidl/event/*.proto |xargs` +# Remove any currently generated file +ls -d protos/docs/event/* | grep -v index.rst | xargs rm +# Use the list to generate the MD files required for sphinx conversion +docker run --rm -v $(pwd)/protos/docs/event:/out -v $(pwd)/protos:/protos pseudomuto/protoc-gen-doc --doc_opt=markdown,event.md -I=protos `echo $event_proto_files` + +# Get list of proto files in plugins directory. +plugins_proto_files=`ls protos/flyteidl/plugins/*.proto | xargs` +# Remove any currently generated file +ls -d protos/docs/plugins/* |grep -v index.rst| xargs rm +# Use the list to generate the MD files required for sphinx conversion +docker run --rm -v $(pwd)/protos/docs/plugins:/out -v $(pwd)/protos:/protos -v $(pwd)/tmp/doc_gen_deps/:/usr/local/include/doc_gen_deps pseudomuto/protoc-gen-doc --doc_opt=markdown,plugins.md -I=protos -I=/usr/local/include/doc_gen_deps `echo $plugins_proto_files` + +# Get list of proto files in service directory. +service_proto_files=`ls protos/flyteidl/service/*.proto | xargs` +# Remove any currently generated file +ls -d protos/docs/service/* |grep -v index.rst| xargs rm +# Use the list to generate the MD files required for sphinx conversion +docker run --rm -v $(pwd)/protos/docs/service:/out -v $(pwd)/protos:/protos -v $(pwd)/tmp/doc_gen_deps/:/usr/local/include/doc_gen_deps pseudomuto/protoc-gen-doc --doc_opt=markdown,service.md -I=protos -I=/usr/local/include/doc_gen_deps `echo $service_proto_files` # Generate binary data from OpenAPI 2 file docker run --rm -u $(id -u):$(id -g) -v $DIR/gen/pb-go/flyteidl/service:/service --entrypoint go-bindata $LYFT_IMAGE -pkg service -o /service/openapi.go -prefix /service/ -modtime 1562572800 /service/admin.swagger.json diff --git a/flyteidl/index.rst b/flyteidl/index.rst index 3a018e8d26..d8e8bb2944 100644 --- a/flyteidl/index.rst +++ b/flyteidl/index.rst @@ -29,5 +29,5 @@ This specification is used to generate client stubs for `FlyteKit - gen/pb-protodoc/flyteidl/index + protos/index developing diff --git a/flyteidl/protos/docs/admin/admin.md b/flyteidl/protos/docs/admin/admin.md new file mode 100644 index 0000000000..c65ee08be4 --- /dev/null +++ b/flyteidl/protos/docs/admin/admin.md @@ -0,0 +1,2746 @@ +# Protocol Documentation + + +## Table of Contents + +- [flyteidl/admin/common.proto](#flyteidl/admin/common.proto) + - [Annotations](#flyteidl.admin.Annotations) + - [Annotations.ValuesEntry](#flyteidl.admin.Annotations.ValuesEntry) + - [AuthRole](#flyteidl.admin.AuthRole) + - [EmailNotification](#flyteidl.admin.EmailNotification) + - [Labels](#flyteidl.admin.Labels) + - [Labels.ValuesEntry](#flyteidl.admin.Labels.ValuesEntry) + - [NamedEntity](#flyteidl.admin.NamedEntity) + - [NamedEntityGetRequest](#flyteidl.admin.NamedEntityGetRequest) + - [NamedEntityIdentifier](#flyteidl.admin.NamedEntityIdentifier) + - [NamedEntityIdentifierList](#flyteidl.admin.NamedEntityIdentifierList) + - [NamedEntityIdentifierListRequest](#flyteidl.admin.NamedEntityIdentifierListRequest) + - [NamedEntityList](#flyteidl.admin.NamedEntityList) + - [NamedEntityListRequest](#flyteidl.admin.NamedEntityListRequest) + - [NamedEntityMetadata](#flyteidl.admin.NamedEntityMetadata) + - [NamedEntityUpdateRequest](#flyteidl.admin.NamedEntityUpdateRequest) + - [NamedEntityUpdateResponse](#flyteidl.admin.NamedEntityUpdateResponse) + - [Notification](#flyteidl.admin.Notification) + - [ObjectGetRequest](#flyteidl.admin.ObjectGetRequest) + - [PagerDutyNotification](#flyteidl.admin.PagerDutyNotification) + - [RawOutputDataConfig](#flyteidl.admin.RawOutputDataConfig) + - [ResourceListRequest](#flyteidl.admin.ResourceListRequest) + - [SlackNotification](#flyteidl.admin.SlackNotification) + - [Sort](#flyteidl.admin.Sort) + - [UrlBlob](#flyteidl.admin.UrlBlob) + + - [NamedEntityState](#flyteidl.admin.NamedEntityState) + - [Sort.Direction](#flyteidl.admin.Sort.Direction) + +- [flyteidl/admin/event.proto](#flyteidl/admin/event.proto) + - [EventErrorAlreadyInTerminalState](#flyteidl.admin.EventErrorAlreadyInTerminalState) + - [EventFailureReason](#flyteidl.admin.EventFailureReason) + - [NodeExecutionEventRequest](#flyteidl.admin.NodeExecutionEventRequest) + - [NodeExecutionEventResponse](#flyteidl.admin.NodeExecutionEventResponse) + - [TaskExecutionEventRequest](#flyteidl.admin.TaskExecutionEventRequest) + - [TaskExecutionEventResponse](#flyteidl.admin.TaskExecutionEventResponse) + - [WorkflowExecutionEventRequest](#flyteidl.admin.WorkflowExecutionEventRequest) + - [WorkflowExecutionEventResponse](#flyteidl.admin.WorkflowExecutionEventResponse) + +- [flyteidl/admin/execution.proto](#flyteidl/admin/execution.proto) + - [AbortMetadata](#flyteidl.admin.AbortMetadata) + - [Execution](#flyteidl.admin.Execution) + - [ExecutionClosure](#flyteidl.admin.ExecutionClosure) + - [ExecutionCreateRequest](#flyteidl.admin.ExecutionCreateRequest) + - [ExecutionCreateResponse](#flyteidl.admin.ExecutionCreateResponse) + - [ExecutionList](#flyteidl.admin.ExecutionList) + - [ExecutionMetadata](#flyteidl.admin.ExecutionMetadata) + - [ExecutionRelaunchRequest](#flyteidl.admin.ExecutionRelaunchRequest) + - [ExecutionSpec](#flyteidl.admin.ExecutionSpec) + - [ExecutionTerminateRequest](#flyteidl.admin.ExecutionTerminateRequest) + - [ExecutionTerminateResponse](#flyteidl.admin.ExecutionTerminateResponse) + - [LiteralMapBlob](#flyteidl.admin.LiteralMapBlob) + - [NotificationList](#flyteidl.admin.NotificationList) + - [SystemMetadata](#flyteidl.admin.SystemMetadata) + - [WorkflowExecutionGetDataRequest](#flyteidl.admin.WorkflowExecutionGetDataRequest) + - [WorkflowExecutionGetDataResponse](#flyteidl.admin.WorkflowExecutionGetDataResponse) + - [WorkflowExecutionGetRequest](#flyteidl.admin.WorkflowExecutionGetRequest) + + - [ExecutionMetadata.ExecutionMode](#flyteidl.admin.ExecutionMetadata.ExecutionMode) + +- [flyteidl/admin/launch_plan.proto](#flyteidl/admin/launch_plan.proto) + - [ActiveLaunchPlanListRequest](#flyteidl.admin.ActiveLaunchPlanListRequest) + - [ActiveLaunchPlanRequest](#flyteidl.admin.ActiveLaunchPlanRequest) + - [Auth](#flyteidl.admin.Auth) + - [LaunchPlan](#flyteidl.admin.LaunchPlan) + - [LaunchPlanClosure](#flyteidl.admin.LaunchPlanClosure) + - [LaunchPlanCreateRequest](#flyteidl.admin.LaunchPlanCreateRequest) + - [LaunchPlanCreateResponse](#flyteidl.admin.LaunchPlanCreateResponse) + - [LaunchPlanList](#flyteidl.admin.LaunchPlanList) + - [LaunchPlanMetadata](#flyteidl.admin.LaunchPlanMetadata) + - [LaunchPlanSpec](#flyteidl.admin.LaunchPlanSpec) + - [LaunchPlanUpdateRequest](#flyteidl.admin.LaunchPlanUpdateRequest) + - [LaunchPlanUpdateResponse](#flyteidl.admin.LaunchPlanUpdateResponse) + + - [LaunchPlanState](#flyteidl.admin.LaunchPlanState) + +- [flyteidl/admin/matchable_resource.proto](#flyteidl/admin/matchable_resource.proto) + - [ClusterResourceAttributes](#flyteidl.admin.ClusterResourceAttributes) + - [ClusterResourceAttributes.AttributesEntry](#flyteidl.admin.ClusterResourceAttributes.AttributesEntry) + - [ExecutionClusterLabel](#flyteidl.admin.ExecutionClusterLabel) + - [ExecutionQueueAttributes](#flyteidl.admin.ExecutionQueueAttributes) + - [ListMatchableAttributesRequest](#flyteidl.admin.ListMatchableAttributesRequest) + - [ListMatchableAttributesResponse](#flyteidl.admin.ListMatchableAttributesResponse) + - [MatchableAttributesConfiguration](#flyteidl.admin.MatchableAttributesConfiguration) + - [MatchingAttributes](#flyteidl.admin.MatchingAttributes) + - [PluginOverride](#flyteidl.admin.PluginOverride) + - [PluginOverrides](#flyteidl.admin.PluginOverrides) + - [TaskResourceAttributes](#flyteidl.admin.TaskResourceAttributes) + - [TaskResourceSpec](#flyteidl.admin.TaskResourceSpec) + + - [MatchableResource](#flyteidl.admin.MatchableResource) + - [PluginOverride.MissingPluginBehavior](#flyteidl.admin.PluginOverride.MissingPluginBehavior) + +- [flyteidl/admin/node_execution.proto](#flyteidl/admin/node_execution.proto) + - [DynamicWorkflowNodeMetadata](#flyteidl.admin.DynamicWorkflowNodeMetadata) + - [NodeExecution](#flyteidl.admin.NodeExecution) + - [NodeExecutionClosure](#flyteidl.admin.NodeExecutionClosure) + - [NodeExecutionForTaskListRequest](#flyteidl.admin.NodeExecutionForTaskListRequest) + - [NodeExecutionGetDataRequest](#flyteidl.admin.NodeExecutionGetDataRequest) + - [NodeExecutionGetDataResponse](#flyteidl.admin.NodeExecutionGetDataResponse) + - [NodeExecutionGetRequest](#flyteidl.admin.NodeExecutionGetRequest) + - [NodeExecutionList](#flyteidl.admin.NodeExecutionList) + - [NodeExecutionListRequest](#flyteidl.admin.NodeExecutionListRequest) + - [NodeExecutionMetaData](#flyteidl.admin.NodeExecutionMetaData) + - [TaskNodeMetadata](#flyteidl.admin.TaskNodeMetadata) + - [WorkflowNodeMetadata](#flyteidl.admin.WorkflowNodeMetadata) + +- [flyteidl/admin/notification.proto](#flyteidl/admin/notification.proto) + - [EmailMessage](#flyteidl.admin.EmailMessage) + +- [flyteidl/admin/project.proto](#flyteidl/admin/project.proto) + - [Domain](#flyteidl.admin.Domain) + - [Project](#flyteidl.admin.Project) + - [ProjectListRequest](#flyteidl.admin.ProjectListRequest) + - [ProjectRegisterRequest](#flyteidl.admin.ProjectRegisterRequest) + - [ProjectRegisterResponse](#flyteidl.admin.ProjectRegisterResponse) + - [ProjectUpdateResponse](#flyteidl.admin.ProjectUpdateResponse) + - [Projects](#flyteidl.admin.Projects) + + - [Project.ProjectState](#flyteidl.admin.Project.ProjectState) + +- [flyteidl/admin/project_domain_attributes.proto](#flyteidl/admin/project_domain_attributes.proto) + - [ProjectDomainAttributes](#flyteidl.admin.ProjectDomainAttributes) + - [ProjectDomainAttributesDeleteRequest](#flyteidl.admin.ProjectDomainAttributesDeleteRequest) + - [ProjectDomainAttributesDeleteResponse](#flyteidl.admin.ProjectDomainAttributesDeleteResponse) + - [ProjectDomainAttributesGetRequest](#flyteidl.admin.ProjectDomainAttributesGetRequest) + - [ProjectDomainAttributesGetResponse](#flyteidl.admin.ProjectDomainAttributesGetResponse) + - [ProjectDomainAttributesUpdateRequest](#flyteidl.admin.ProjectDomainAttributesUpdateRequest) + - [ProjectDomainAttributesUpdateResponse](#flyteidl.admin.ProjectDomainAttributesUpdateResponse) + +- [flyteidl/admin/schedule.proto](#flyteidl/admin/schedule.proto) + - [CronSchedule](#flyteidl.admin.CronSchedule) + - [FixedRate](#flyteidl.admin.FixedRate) + - [Schedule](#flyteidl.admin.Schedule) + + - [FixedRateUnit](#flyteidl.admin.FixedRateUnit) + +- [flyteidl/admin/task.proto](#flyteidl/admin/task.proto) + - [Task](#flyteidl.admin.Task) + - [TaskClosure](#flyteidl.admin.TaskClosure) + - [TaskCreateRequest](#flyteidl.admin.TaskCreateRequest) + - [TaskCreateResponse](#flyteidl.admin.TaskCreateResponse) + - [TaskList](#flyteidl.admin.TaskList) + - [TaskSpec](#flyteidl.admin.TaskSpec) + +- [flyteidl/admin/task_execution.proto](#flyteidl/admin/task_execution.proto) + - [TaskExecution](#flyteidl.admin.TaskExecution) + - [TaskExecutionClosure](#flyteidl.admin.TaskExecutionClosure) + - [TaskExecutionGetDataRequest](#flyteidl.admin.TaskExecutionGetDataRequest) + - [TaskExecutionGetDataResponse](#flyteidl.admin.TaskExecutionGetDataResponse) + - [TaskExecutionGetRequest](#flyteidl.admin.TaskExecutionGetRequest) + - [TaskExecutionList](#flyteidl.admin.TaskExecutionList) + - [TaskExecutionListRequest](#flyteidl.admin.TaskExecutionListRequest) + +- [flyteidl/admin/version.proto](#flyteidl/admin/version.proto) + - [GetVersionRequest](#flyteidl.admin.GetVersionRequest) + - [GetVersionResponse](#flyteidl.admin.GetVersionResponse) + - [Version](#flyteidl.admin.Version) + +- [flyteidl/admin/workflow.proto](#flyteidl/admin/workflow.proto) + - [Workflow](#flyteidl.admin.Workflow) + - [WorkflowClosure](#flyteidl.admin.WorkflowClosure) + - [WorkflowCreateRequest](#flyteidl.admin.WorkflowCreateRequest) + - [WorkflowCreateResponse](#flyteidl.admin.WorkflowCreateResponse) + - [WorkflowList](#flyteidl.admin.WorkflowList) + - [WorkflowSpec](#flyteidl.admin.WorkflowSpec) + +- [flyteidl/admin/workflow_attributes.proto](#flyteidl/admin/workflow_attributes.proto) + - [WorkflowAttributes](#flyteidl.admin.WorkflowAttributes) + - [WorkflowAttributesDeleteRequest](#flyteidl.admin.WorkflowAttributesDeleteRequest) + - [WorkflowAttributesDeleteResponse](#flyteidl.admin.WorkflowAttributesDeleteResponse) + - [WorkflowAttributesGetRequest](#flyteidl.admin.WorkflowAttributesGetRequest) + - [WorkflowAttributesGetResponse](#flyteidl.admin.WorkflowAttributesGetResponse) + - [WorkflowAttributesUpdateRequest](#flyteidl.admin.WorkflowAttributesUpdateRequest) + - [WorkflowAttributesUpdateResponse](#flyteidl.admin.WorkflowAttributesUpdateResponse) + +- [Scalar Value Types](#scalar-value-types) + + + + +

Top

+ +## flyteidl/admin/common.proto + + + + + +### Annotations +Annotation values to be applied to an execution resource. +In the future a mode (e.g. OVERRIDE, APPEND, etc) can be defined +to specify how to merge annotations defined at registration and execution time. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| values | [Annotations.ValuesEntry](#flyteidl.admin.Annotations.ValuesEntry) | repeated | Map of custom annotations to be applied to the execution resource. | + + + + + + + + +### Annotations.ValuesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + + + + + + +### AuthRole +Defines permissions associated with executions. +Deprecated, please use core.SecurityContext + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| assumable_iam_role | [string](#string) | | | +| kubernetes_service_account | [string](#string) | | | + + + + + + + + +### EmailNotification + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| recipients_email | [string](#string) | repeated | The list of email addresses recipients for this notification. + +[(validate.rules).repeated = {min_items: 1, unique: true, items: {string: {email: true}}}]; | + + + + + + + + +### Labels +Label values to be applied to an execution resource. +In the future a mode (e.g. OVERRIDE, APPEND, etc) can be defined +to specify how to merge labels defined at registration and execution time. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| values | [Labels.ValuesEntry](#flyteidl.admin.Labels.ValuesEntry) | repeated | Map of custom labels to be applied to the execution resource. | + + + + + + + + +### Labels.ValuesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + + + + + + +### NamedEntity +Describes information common to a NamedEntity, identified by a project / +domain / name / resource type combination + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| resource_type | [flyteidl.core.ResourceType](#flyteidl.core.ResourceType) | | | +| id | [NamedEntityIdentifier](#flyteidl.admin.NamedEntityIdentifier) | | | +| metadata | [NamedEntityMetadata](#flyteidl.admin.NamedEntityMetadata) | | | + + + + + + + + +### NamedEntityGetRequest +A request to retrieve the metadata associated with a NamedEntityIdentifier + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| resource_type | [flyteidl.core.ResourceType](#flyteidl.core.ResourceType) | | | +| id | [NamedEntityIdentifier](#flyteidl.admin.NamedEntityIdentifier) | | | + + + + + + + + +### NamedEntityIdentifier +Encapsulation of fields that identifies a Flyte resource. +A resource can internally have multiple versions. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| project | [string](#string) | | Name of the project the resource belongs to. + +[(validate.rules).string.min_bytes = 1]; | +| domain | [string](#string) | | Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project. + +[(validate.rules).string.min_bytes = 1]; | +| name | [string](#string) | | User provided value for the resource. The combination of project + domain + name uniquely identifies the resource. +optional - in certain contexts - like 'List API', 'Launch plans' | + + + + + + + + +### NamedEntityIdentifierList +Represents a list of NamedEntityIdentifiers. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| entities | [NamedEntityIdentifier](#flyteidl.admin.NamedEntityIdentifier) | repeated | A list of identifiers. | +| token | [string](#string) | | In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty. | + + + + + + + + +### NamedEntityIdentifierListRequest +Represents a request structure to list identifiers. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| project | [string](#string) | | Name of the project that contains the identifiers. + +[(validate.rules).string.min_bytes = 1]; | +| domain | [string](#string) | | Name of the domain the identifiers belongs to within the project. + +[(validate.rules).string.min_bytes = 1]; | +| limit | [uint32](#uint32) | | Indicates the number of resources to be returned. | +| token | [string](#string) | | In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. +optional | +| sort_by | [Sort](#flyteidl.admin.Sort) | | Sort ordering. +optional | +| filters | [string](#string) | | Indicates a list of filters passed as string. +optional | + + + + + + + + +### NamedEntityList +Represents a list of NamedEntityIdentifiers. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| entities | [NamedEntity](#flyteidl.admin.NamedEntity) | repeated | A list of NamedEntity objects | +| token | [string](#string) | | In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty. | + + + + + + + + +### NamedEntityListRequest +Represents a request structure to list NamedEntity objects + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| resource_type | [flyteidl.core.ResourceType](#flyteidl.core.ResourceType) | | | +| project | [string](#string) | | Name of the project that contains the identifiers. + +[(validate.rules).string.min_bytes = 1]; | +| domain | [string](#string) | | Name of the domain the identifiers belongs to within the project. + +[(validate.rules).string.min_bytes = 1]; | +| limit | [uint32](#uint32) | | Indicates the number of resources to be returned. | +| token | [string](#string) | | In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. +optional | +| sort_by | [Sort](#flyteidl.admin.Sort) | | Sort ordering. +optional | +| filters | [string](#string) | | Indicates a list of filters passed as string. +optional | + + + + + + + + +### NamedEntityMetadata + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| description | [string](#string) | | Common description across all versions of the entity +optional | +| state | [NamedEntityState](#flyteidl.admin.NamedEntityState) | | Shared state across all version of the entity At this point in time, only workflow entities can have their state archived. | + + + + + + + + +### NamedEntityUpdateRequest +Request to set the referenced launch plan state to the configured value. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| resource_type | [flyteidl.core.ResourceType](#flyteidl.core.ResourceType) | | Resource type of the metadata to update | +| id | [NamedEntityIdentifier](#flyteidl.admin.NamedEntityIdentifier) | | Identifier of the metadata to update | +| metadata | [NamedEntityMetadata](#flyteidl.admin.NamedEntityMetadata) | | Metadata object to set as the new value | + + + + + + + + +### NamedEntityUpdateResponse +Purposefully empty, may be populated in the future. + + + + + + + + +### Notification +Represents a structure for notifications based on execution status. +The Notification content is configured within Admin. Future iterations could +expose configuring notifications with custom content. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| phases | [flyteidl.core.WorkflowExecution.Phase](#flyteidl.core.WorkflowExecution.Phase) | repeated | A list of phases to which users can associate the notifications to. | +| email | [EmailNotification](#flyteidl.admin.EmailNotification) | | option (validate.required) = true; | +| pager_duty | [PagerDutyNotification](#flyteidl.admin.PagerDutyNotification) | | | +| slack | [SlackNotification](#flyteidl.admin.SlackNotification) | | | + + + + + + + + +### ObjectGetRequest +Represents a structure to fetch a single resource. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.Identifier](#flyteidl.core.Identifier) | | Indicates a unique version of resource. | + + + + + + + + +### PagerDutyNotification + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| recipients_email | [string](#string) | repeated | Currently, PagerDuty notifications leverage email to trigger a notification. + +[(validate.rules).repeated = {min_items: 1, unique: true, items: {string: {email: true}}}]; | + + + + + + + + +### RawOutputDataConfig +Encapsulates user settings pertaining to offloaded data (i.e. Blobs, Schema, query data, etc.). +See https://github.com/flyteorg/flyte/issues/211 for more background information. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| output_location_prefix | [string](#string) | | Prefix for where offloaded data from user workflows will be written e.g. s3://bucket/key or s3://bucket/ | + + + + + + + + +### ResourceListRequest +Represents a request structure to retrieve a list of resources. +Resources include: Task, Workflow, LaunchPlan + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [NamedEntityIdentifier](#flyteidl.admin.NamedEntityIdentifier) | | id represents the unique identifier of the resource. | +| limit | [uint32](#uint32) | | Indicates the number of resources to be returned. | +| token | [string](#string) | | In the case of multiple pages of results, this server-provided token can be used to fetch the next page in a query. +optional | +| filters | [string](#string) | | Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional | +| sort_by | [Sort](#flyteidl.admin.Sort) | | Sort ordering. +optional | + + + + + + + + +### SlackNotification + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| recipients_email | [string](#string) | repeated | Currently, Slack notifications leverage email to trigger a notification. + +[(validate.rules).repeated = {min_items: 1, unique: true, items: {string: {email: true}}}]; | + + + + + + + + +### Sort +Species sort ordering in a list request. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | Indicates an attribute to sort the response values. TODO(katrogan): Add string validation here. This should never be empty. | +| direction | [Sort.Direction](#flyteidl.admin.Sort.Direction) | | Indicates the direction to apply sort key for response values. +optional | + + + + + + + + +### UrlBlob +Represents a string url and associated metadata used throughout the platform. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| url | [string](#string) | | Actual url value. | +| bytes | [int64](#int64) | | Represents the size of the file accessible at the above url. | + + + + + + + + + + +### NamedEntityState +The status of the named entity is used to control its visibility in the UI. + +| Name | Number | Description | +| ---- | ------ | ----------- | +| NAMED_ENTITY_ACTIVE | 0 | By default, all named entities are considered active and under development. | +| NAMED_ENTITY_ARCHIVED | 1 | Archived named entities are no longer visible in the UI. | +| SYSTEM_GENERATED | 2 | System generated entities that aren't explicitly created or managed by a user. | + + + + + +### Sort.Direction + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| DESCENDING | 0 | | +| ASCENDING | 1 | | + + + + + + + + + + + +

Top

+ +## flyteidl/admin/event.proto + + + + + +### EventErrorAlreadyInTerminalState + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| current_phase | [string](#string) | | | + + + + + + + + +### EventFailureReason + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| already_in_terminal_state | [EventErrorAlreadyInTerminalState](#flyteidl.admin.EventErrorAlreadyInTerminalState) | | | + + + + + + + + +### NodeExecutionEventRequest +Request to send a notification that a node execution event has occurred. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| request_id | [string](#string) | | Unique ID for this request that can be traced between services | +| event | [flyteidl.event.NodeExecutionEvent](#flyteidl.event.NodeExecutionEvent) | | Details about the event that occurred. | + + + + + + + + +### NodeExecutionEventResponse +a placeholder for now + + + + + + + + +### TaskExecutionEventRequest +Request to send a notification that a task execution event has occurred. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| request_id | [string](#string) | | Unique ID for this request that can be traced between services | +| event | [flyteidl.event.TaskExecutionEvent](#flyteidl.event.TaskExecutionEvent) | | Details about the event that occurred. | + + + + + + + + +### TaskExecutionEventResponse +a placeholder for now + + + + + + + + +### WorkflowExecutionEventRequest +Request to send a notification that a workflow execution event has occurred. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| request_id | [string](#string) | | Unique ID for this request that can be traced between services | +| event | [flyteidl.event.WorkflowExecutionEvent](#flyteidl.event.WorkflowExecutionEvent) | | Details about the event that occurred. | + + + + + + + + +### WorkflowExecutionEventResponse +a placeholder for now + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/admin/execution.proto + + + + + +### AbortMetadata + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cause | [string](#string) | | In the case of a user-specified abort, this will pass along the user-supplied cause. | +| principal | [string](#string) | | Identifies the entity (if any) responsible for terminating the execution | + + + + + + + + +### Execution +A workflow execution represents an instantiated workflow, including all inputs and additional +metadata as well as computed results included state, outputs, and duration-based attributes. +Used as a response object used in Get and List execution requests. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.WorkflowExecutionIdentifier](#flyteidl.core.WorkflowExecutionIdentifier) | | Unique identifier of the workflow execution. | +| spec | [ExecutionSpec](#flyteidl.admin.ExecutionSpec) | | User-provided configuration and inputs for launching the execution. | +| closure | [ExecutionClosure](#flyteidl.admin.ExecutionClosure) | | Execution results. | + + + + + + + + +### ExecutionClosure +Encapsulates the results of the Execution + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| outputs | [LiteralMapBlob](#flyteidl.admin.LiteralMapBlob) | | A map of outputs in the case of a successful execution. | +| error | [flyteidl.core.ExecutionError](#flyteidl.core.ExecutionError) | | Error information in the case of a failed execution. | +| abort_cause | [string](#string) | | **Deprecated.** In the case of a user-specified abort, this will pass along the user-supplied cause. | +| abort_metadata | [AbortMetadata](#flyteidl.admin.AbortMetadata) | | In the case of a user-specified abort, this will pass along the user and their supplied cause. | +| computed_inputs | [flyteidl.core.LiteralMap](#flyteidl.core.LiteralMap) | | **Deprecated.** Inputs computed and passed for execution. computed_inputs depends on inputs in ExecutionSpec, fixed and default inputs in launch plan | +| phase | [flyteidl.core.WorkflowExecution.Phase](#flyteidl.core.WorkflowExecution.Phase) | | Most recent recorded phase for the execution. | +| started_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | Reported ime at which the execution began running. | +| duration | [google.protobuf.Duration](#google.protobuf.Duration) | | The amount of time the execution spent running. | +| created_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | Reported time at which the execution was created. | +| updated_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | Reported time at which the execution was last updated. | +| notifications | [Notification](#flyteidl.admin.Notification) | repeated | The notification settings to use after merging the CreateExecutionRequest and the launch plan notification settings. An execution launched with notifications will always prefer that definition to notifications defined statically in a launch plan. | +| workflow_id | [flyteidl.core.Identifier](#flyteidl.core.Identifier) | | Identifies the workflow definition for this execution. | + + + + + + + + +### ExecutionCreateRequest +Request to launch an execution with the given project, domain and optionally name. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| project | [string](#string) | | Name of the project the execution belongs to. | +| domain | [string](#string) | | Name of the domain the execution belongs to. A domain can be considered as a subset within a specific project. | +| name | [string](#string) | | User provided value for the resource. If none is provided the system will generate a unique string. +optional | +| spec | [ExecutionSpec](#flyteidl.admin.ExecutionSpec) | | Additional fields necessary to launch the execution. | +| inputs | [flyteidl.core.LiteralMap](#flyteidl.core.LiteralMap) | | The inputs required to start the execution. All required inputs must be included in this map. If not required and not provided, defaults apply. | + + + + + + + + +### ExecutionCreateResponse +The unique identifier for a successfully created execution. +If the name was *not* specified in the create request, this identifier will include a generated name. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.WorkflowExecutionIdentifier](#flyteidl.core.WorkflowExecutionIdentifier) | | | + + + + + + + + +### ExecutionList +Used as a response for request to list executions. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| executions | [Execution](#flyteidl.admin.Execution) | repeated | | +| token | [string](#string) | | In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty. | + + + + + + + + +### ExecutionMetadata +Represents attributes about an execution which are not required to launch the execution but are useful to record. +These attributes are assigned at launch time and do not change. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| mode | [ExecutionMetadata.ExecutionMode](#flyteidl.admin.ExecutionMetadata.ExecutionMode) | | [(validate.rules).enum.defined_only = true]; | +| principal | [string](#string) | | Identifier of the entity that triggered this execution. For systems using back-end authentication any value set here will be discarded in favor of the authenticated user context. | +| nesting | [uint32](#uint32) | | Indicates the "nestedness" of this execution. If a user launches a workflow execution, the default nesting is 0. If this execution further launches a workflow (child workflow), the nesting level is incremented by 0 => 1 Generally, if workflow at nesting level k launches a workflow then the child workflow will have nesting = k + 1. | +| scheduled_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | For scheduled executions, the requested time for execution for this specific schedule invocation. | +| parent_node_execution | [flyteidl.core.NodeExecutionIdentifier](#flyteidl.core.NodeExecutionIdentifier) | | Which subworkflow node launched this execution | +| reference_execution | [flyteidl.core.WorkflowExecutionIdentifier](#flyteidl.core.WorkflowExecutionIdentifier) | | Optional, a reference workflow execution related to this execution. In the case of a relaunch, this references the original workflow execution. | +| system_metadata | [SystemMetadata](#flyteidl.admin.SystemMetadata) | | Optional, platform-specific metadata about the execution. In this the future this may be gated behind an ACL or some sort of authorization. | + + + + + + + + +### ExecutionRelaunchRequest +Request to relaunch the referenced execution. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.WorkflowExecutionIdentifier](#flyteidl.core.WorkflowExecutionIdentifier) | | Identifier of the workflow execution to relaunch. | +| name | [string](#string) | | User provided value for the relaunched execution. If none is provided the system will generate a unique string. +optional | + + + + + + + + +### ExecutionSpec +An ExecutionSpec encompasses all data used to launch this execution. The Spec does not change over the lifetime +of an execution as it progresses across phase changes.. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| launch_plan | [flyteidl.core.Identifier](#flyteidl.core.Identifier) | | Launch plan to be executed | +| inputs | [flyteidl.core.LiteralMap](#flyteidl.core.LiteralMap) | | **Deprecated.** Input values to be passed for the execution | +| metadata | [ExecutionMetadata](#flyteidl.admin.ExecutionMetadata) | | Metadata for the execution | +| notifications | [NotificationList](#flyteidl.admin.NotificationList) | | List of notifications based on Execution status transitions When this list is not empty it is used rather than any notifications defined in the referenced launch plan. When this list is empty, the notifications defined for the launch plan will be applied. | +| disable_all | [bool](#bool) | | This should be set to true if all notifications are intended to be disabled for this execution. | +| labels | [Labels](#flyteidl.admin.Labels) | | Labels to apply to the execution resource. | +| annotations | [Annotations](#flyteidl.admin.Annotations) | | Annotations to apply to the execution resource. | +| security_context | [flyteidl.core.SecurityContext](#flyteidl.core.SecurityContext) | | Optional: security context override to apply this execution. | +| auth_role | [AuthRole](#flyteidl.admin.AuthRole) | | **Deprecated.** Optional: auth override to apply this execution. | +| quality_of_service | [flyteidl.core.QualityOfService](#flyteidl.core.QualityOfService) | | Indicates the runtime priority of the execution. | + + + + + + + + +### ExecutionTerminateRequest +Request to terminate an in-progress execution. This action is irreversible. +If an execution is already terminated, this request will simply be a no-op. +This request will fail if it references a non-existent execution. +If the request succeeds the phase "ABORTED" will be recorded for the termination +with the optional cause added to the output_result. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.WorkflowExecutionIdentifier](#flyteidl.core.WorkflowExecutionIdentifier) | | Uniquely identifies the individual workflow execution to be terminated. | +| cause | [string](#string) | | Optional reason for aborting. | + + + + + + + + +### ExecutionTerminateResponse +Purposefully empty, may be populated in the future. + + + + + + + + +### LiteralMapBlob +Input/output data can represented by actual values or a link to where values are stored + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| values | [flyteidl.core.LiteralMap](#flyteidl.core.LiteralMap) | | Data in LiteralMap format | +| uri | [string](#string) | | In the event that the map is too large, we return a uri to the data | + + + + + + + + +### NotificationList + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| notifications | [Notification](#flyteidl.admin.Notification) | repeated | | + + + + + + + + +### SystemMetadata +Represents system rather than user-facing metadata about an execution. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| execution_cluster | [string](#string) | | Which execution cluster this execution ran on. | + + + + + + + + +### WorkflowExecutionGetDataRequest +Request structure to fetch inputs and output urls for an execution. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.WorkflowExecutionIdentifier](#flyteidl.core.WorkflowExecutionIdentifier) | | The identifier of the execution for which to fetch inputs and outputs. | + + + + + + + + +### WorkflowExecutionGetDataResponse +Response structure for WorkflowExecutionGetDataRequest which contains inputs and outputs for an execution. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| outputs | [UrlBlob](#flyteidl.admin.UrlBlob) | | Signed url to fetch a core.LiteralMap of execution outputs. | +| inputs | [UrlBlob](#flyteidl.admin.UrlBlob) | | Signed url to fetch a core.LiteralMap of execution inputs. | +| full_inputs | [flyteidl.core.LiteralMap](#flyteidl.core.LiteralMap) | | Optional, full_inputs will only be populated if they are under a configured size threshold. | +| full_outputs | [flyteidl.core.LiteralMap](#flyteidl.core.LiteralMap) | | Optional, full_outputs will only be populated if they are under a configured size threshold. | + + + + + + + + +### WorkflowExecutionGetRequest +A message used to fetch a single workflow execution entity. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.WorkflowExecutionIdentifier](#flyteidl.core.WorkflowExecutionIdentifier) | | Uniquely identifies an individual workflow execution. | + + + + + + + + + + +### ExecutionMetadata.ExecutionMode +The method by which this execution was launched. + +| Name | Number | Description | +| ---- | ------ | ----------- | +| MANUAL | 0 | The default execution mode, MANUAL implies that an execution was launched by an individual. | +| SCHEDULED | 1 | A schedule triggered this execution launch. | +| SYSTEM | 2 | A system process was responsible for launching this execution rather an individual. | +| RELAUNCH | 3 | This execution was launched with identical inputs as a previous execution. | +| CHILD_WORKFLOW | 4 | This execution was triggered by another execution. | + + + + + + + + + + + +

Top

+ +## flyteidl/admin/launch_plan.proto + + + + + +### ActiveLaunchPlanListRequest +Represents a request structure to list active launch plans within a project/domain. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| project | [string](#string) | | Name of the project that contains the identifiers. + +[(validate.rules).string.min_bytes = 1]; | +| domain | [string](#string) | | Name of the domain the identifiers belongs to within the project. + +[(validate.rules).string.min_bytes = 1]; | +| limit | [uint32](#uint32) | | Indicates the number of resources to be returned. | +| token | [string](#string) | | In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. +optional | +| sort_by | [Sort](#flyteidl.admin.Sort) | | Sort ordering. +optional | + + + + + + + + +### ActiveLaunchPlanRequest +Represents a request struct for finding an active launch plan for a given NamedEntityIdentifier + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [NamedEntityIdentifier](#flyteidl.admin.NamedEntityIdentifier) | | | + + + + + + + + +### Auth +Defines permissions associated with executions created by this launch plan spec. +Deprecated. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| assumable_iam_role | [string](#string) | | | +| kubernetes_service_account | [string](#string) | | | + + + + + + + + +### LaunchPlan +A LaunchPlan provides the capability to templatize workflow executions. +Launch plans simplify associating one or more schedules, inputs and notifications with your workflows. +Launch plans can be shared and used to trigger executions with predefined inputs even when a workflow +definition doesn't necessarily have a default value for said input. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.Identifier](#flyteidl.core.Identifier) | | | +| spec | [LaunchPlanSpec](#flyteidl.admin.LaunchPlanSpec) | | | +| closure | [LaunchPlanClosure](#flyteidl.admin.LaunchPlanClosure) | | | + + + + + + + + +### LaunchPlanClosure +Values computed by the flyte platform after launch plan registration. +These include expected_inputs required to be present in a CreateExecutionRequest +to launch the reference workflow as well timestamp values associated with the launch plan. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| state | [LaunchPlanState](#flyteidl.admin.LaunchPlanState) | | Indicate the Launch plan phase | +| expected_inputs | [flyteidl.core.ParameterMap](#flyteidl.core.ParameterMap) | | Indicates the set of inputs to execute the Launch plan | +| expected_outputs | [flyteidl.core.VariableMap](#flyteidl.core.VariableMap) | | Indicates the set of outputs from the Launch plan | +| created_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | Time at which the launch plan was created. | +| updated_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | Time at which the launch plan was last updated. | + + + + + + + + +### LaunchPlanCreateRequest +Request to register a launch plan. A LaunchPlanSpec may include a complete or incomplete set of inputs required +to launch a workflow execution. By default all launch plans are registered in state INACTIVE. If you wish to +set the state to ACTIVE, you must submit a LaunchPlanUpdateRequest, after you have created a launch plan. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.Identifier](#flyteidl.core.Identifier) | | Uniquely identifies a launch plan entity. | +| spec | [LaunchPlanSpec](#flyteidl.admin.LaunchPlanSpec) | | User-provided launch plan details, including reference workflow, inputs and other metadata. | + + + + + + + + +### LaunchPlanCreateResponse +Purposefully empty, may be populated in the future. + + + + + + + + +### LaunchPlanList +Response object for list launch plan requests. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| launch_plans | [LaunchPlan](#flyteidl.admin.LaunchPlan) | repeated | | +| token | [string](#string) | | In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty. | + + + + + + + + +### LaunchPlanMetadata +Additional launch plan attributes included in the LaunchPlanSpec not strictly required to launch +the reference workflow. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| schedule | [Schedule](#flyteidl.admin.Schedule) | | Schedule to execute the Launch Plan | +| notifications | [Notification](#flyteidl.admin.Notification) | repeated | List of notifications based on Execution status transitions | + + + + + + + + +### LaunchPlanSpec +User-provided launch plan definition and configuration values. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| workflow_id | [flyteidl.core.Identifier](#flyteidl.core.Identifier) | | Reference to the Workflow template that the launch plan references | +| entity_metadata | [LaunchPlanMetadata](#flyteidl.admin.LaunchPlanMetadata) | | Metadata for the Launch Plan | +| default_inputs | [flyteidl.core.ParameterMap](#flyteidl.core.ParameterMap) | | Input values to be passed for the execution | +| fixed_inputs | [flyteidl.core.LiteralMap](#flyteidl.core.LiteralMap) | | Fixed, non-overridable inputs for the Launch Plan | +| role | [string](#string) | | **Deprecated.** String to indicate the role to use to execute the workflow underneath | +| labels | [Labels](#flyteidl.admin.Labels) | | Custom labels to be applied to the execution resource. | +| annotations | [Annotations](#flyteidl.admin.Annotations) | | Custom annotations to be applied to the execution resource. | +| auth | [Auth](#flyteidl.admin.Auth) | | **Deprecated.** Indicates the permission associated with workflow executions triggered with this launch plan. | +| auth_role | [AuthRole](#flyteidl.admin.AuthRole) | | **Deprecated.** | +| security_context | [flyteidl.core.SecurityContext](#flyteidl.core.SecurityContext) | | Indicates security context for permissions triggered with this launch plan | +| quality_of_service | [flyteidl.core.QualityOfService](#flyteidl.core.QualityOfService) | | Indicates the runtime priority of the execution. | +| raw_output_data_config | [RawOutputDataConfig](#flyteidl.admin.RawOutputDataConfig) | | | + + + + + + + + +### LaunchPlanUpdateRequest +Request to set the referenced launch plan state to the configured value. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.Identifier](#flyteidl.core.Identifier) | | Identifier of launch plan for which to change state. | +| state | [LaunchPlanState](#flyteidl.admin.LaunchPlanState) | | Desired state to apply to the launch plan. | + + + + + + + + +### LaunchPlanUpdateResponse +Purposefully empty, may be populated in the future. + + + + + + + + + + +### LaunchPlanState +By default any launch plan regardless of state can be used to launch a workflow execution. +However, at most one version of a launch plan +(e.g. a NamedEntityIdentifier set of shared project, domain and name values) can be +active at a time in regards to *schedules*. That is, at most one schedule in a NamedEntityIdentifier +group will be observed and trigger executions at a defined cadence. + +| Name | Number | Description | +| ---- | ------ | ----------- | +| INACTIVE | 0 | | +| ACTIVE | 1 | | + + + + + + + + + + + +

Top

+ +## flyteidl/admin/matchable_resource.proto + + + + + +### ClusterResourceAttributes + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| attributes | [ClusterResourceAttributes.AttributesEntry](#flyteidl.admin.ClusterResourceAttributes.AttributesEntry) | repeated | Custom resource attributes which will be applied in cluster resource creation (e.g. quotas). Map keys are the *case-sensitive* names of variables in templatized resource files. Map values should be the custom values which get substituted during resource creation. | + + + + + + + + +### ClusterResourceAttributes.AttributesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + + + + + + +### ExecutionClusterLabel + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| value | [string](#string) | | Label value to determine where the execution will be run | + + + + + + + + +### ExecutionQueueAttributes + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| tags | [string](#string) | repeated | Tags used for assigning execution queues for tasks defined within this project. | + + + + + + + + +### ListMatchableAttributesRequest +Request all matching resource attributes. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| resource_type | [MatchableResource](#flyteidl.admin.MatchableResource) | | | + + + + + + + + +### ListMatchableAttributesResponse +Response for a request for all matching resource attributes. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| configurations | [MatchableAttributesConfiguration](#flyteidl.admin.MatchableAttributesConfiguration) | repeated | | + + + + + + + + +### MatchableAttributesConfiguration +Represents a custom set of attributes applied for either a domain; a domain and project; or +domain, project and workflow name. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| attributes | [MatchingAttributes](#flyteidl.admin.MatchingAttributes) | | | +| domain | [string](#string) | | | +| project | [string](#string) | | | +| workflow | [string](#string) | | | +| launch_plan | [string](#string) | | | + + + + + + + + +### MatchingAttributes +Generic container for encapsulating all types of the above attributes messages. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| task_resource_attributes | [TaskResourceAttributes](#flyteidl.admin.TaskResourceAttributes) | | | +| cluster_resource_attributes | [ClusterResourceAttributes](#flyteidl.admin.ClusterResourceAttributes) | | | +| execution_queue_attributes | [ExecutionQueueAttributes](#flyteidl.admin.ExecutionQueueAttributes) | | | +| execution_cluster_label | [ExecutionClusterLabel](#flyteidl.admin.ExecutionClusterLabel) | | | +| quality_of_service | [flyteidl.core.QualityOfService](#flyteidl.core.QualityOfService) | | | +| plugin_overrides | [PluginOverrides](#flyteidl.admin.PluginOverrides) | | | + + + + + + + + +### PluginOverride +This MatchableAttribute configures selecting alternate plugin implementations for a given task type. +In addition to an override implementation a selection of fallbacks can be provided or other modes +for handling cases where the desired plugin override is not enabled in a given Flyte deployment. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| task_type | [string](#string) | | A predefined yet extensible Task type identifier. | +| plugin_id | [string](#string) | repeated | A set of plugin ids which should handle tasks of this type instead of the default registered plugin. The list will be tried in order until a plugin is found with that id. | +| missing_plugin_behavior | [PluginOverride.MissingPluginBehavior](#flyteidl.admin.PluginOverride.MissingPluginBehavior) | | Defines the behavior when no plugin from the plugin_id list is not found. | + + + + + + + + +### PluginOverrides + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| overrides | [PluginOverride](#flyteidl.admin.PluginOverride) | repeated | | + + + + + + + + +### TaskResourceAttributes + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| defaults | [TaskResourceSpec](#flyteidl.admin.TaskResourceSpec) | | | +| limits | [TaskResourceSpec](#flyteidl.admin.TaskResourceSpec) | | | + + + + + + + + +### TaskResourceSpec + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cpu | [string](#string) | | | +| gpu | [string](#string) | | | +| memory | [string](#string) | | | +| storage | [string](#string) | | | + + + + + + + + + + +### MatchableResource +Defines a resource that can be configured by customizable Project-, ProjectDomain- or WorkflowAttributes +based on matching tags. + +| Name | Number | Description | +| ---- | ------ | ----------- | +| TASK_RESOURCE | 0 | Applies to customizable task resource requests and limits. | +| CLUSTER_RESOURCE | 1 | Applies to configuring templated kubernetes cluster resources. | +| EXECUTION_QUEUE | 2 | Configures task and dynamic task execution queue assignment. | +| EXECUTION_CLUSTER_LABEL | 3 | Configures the K8s cluster label to be used for execution to be run | +| QUALITY_OF_SERVICE_SPECIFICATION | 4 | Configures default quality of service when undefined in an execution spec. | +| PLUGIN_OVERRIDE | 5 | Selects configurable plugin implementation behavior for a given task type. | + + + + + +### PluginOverride.MissingPluginBehavior + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| FAIL | 0 | | +| USE_DEFAULT | 1 | Uses the system-configured default implementation. | + + + + + + + + + + + +

Top

+ +## flyteidl/admin/node_execution.proto + + + + + +### DynamicWorkflowNodeMetadata +For dynamic workflow nodes we capture information about the dynamic workflow definition that gets generated. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.Identifier](#flyteidl.core.Identifier) | | id represents the unique identifier of the workflow. | +| compiled_workflow | [flyteidl.core.CompiledWorkflowClosure](#flyteidl.core.CompiledWorkflowClosure) | | Represents the compiled representation of the embedded dynamic workflow. | + + + + + + + + +### NodeExecution +Encapsulates all details for a single node execution entity. +A node represents a component in the overall workflow graph. A node launch a task, multiple tasks, an entire nested +sub-workflow, or even a separate child-workflow execution. +The same task can be called repeatedly in a single workflow but each node is unique. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.NodeExecutionIdentifier](#flyteidl.core.NodeExecutionIdentifier) | | Uniquely identifies an individual node execution. | +| input_uri | [string](#string) | | Path to remote data store where input blob is stored. | +| closure | [NodeExecutionClosure](#flyteidl.admin.NodeExecutionClosure) | | Computed results associated with this node execution. | +| metadata | [NodeExecutionMetaData](#flyteidl.admin.NodeExecutionMetaData) | | Metadata for Node Execution | + + + + + + + + +### NodeExecutionClosure +Container for node execution details and results. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| output_uri | [string](#string) | | | +| error | [flyteidl.core.ExecutionError](#flyteidl.core.ExecutionError) | | Error information for the Node | +| phase | [flyteidl.core.NodeExecution.Phase](#flyteidl.core.NodeExecution.Phase) | | The last recorded phase for this node execution. | +| started_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | Time at which the node execution began running. | +| duration | [google.protobuf.Duration](#google.protobuf.Duration) | | The amount of time the node execution spent running. | +| created_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | Time at which the node execution was created. | +| updated_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | Time at which the node execution was last updated. | +| workflow_node_metadata | [WorkflowNodeMetadata](#flyteidl.admin.WorkflowNodeMetadata) | | | +| task_node_metadata | [TaskNodeMetadata](#flyteidl.admin.TaskNodeMetadata) | | | + + + + + + + + +### NodeExecutionForTaskListRequest +Represents a request structure to retrieve a list of node execution entities launched by a specific task. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| task_execution_id | [flyteidl.core.TaskExecutionIdentifier](#flyteidl.core.TaskExecutionIdentifier) | | Indicates the node execution to filter by. | +| limit | [uint32](#uint32) | | Indicates the number of resources to be returned. | +| token | [string](#string) | | In the case of multiple pages of results, the, server-provided token can be used to fetch the next page in a query. +optional | +| filters | [string](#string) | | Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional | +| sort_by | [Sort](#flyteidl.admin.Sort) | | Sort ordering. +optional | + + + + + + + + +### NodeExecutionGetDataRequest +Request structure to fetch inputs and output urls for a node execution. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.NodeExecutionIdentifier](#flyteidl.core.NodeExecutionIdentifier) | | The identifier of the node execution for which to fetch inputs and outputs. | + + + + + + + + +### NodeExecutionGetDataResponse +Response structure for NodeExecutionGetDataRequest which contains inputs and outputs for a node execution. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| inputs | [UrlBlob](#flyteidl.admin.UrlBlob) | | Signed url to fetch a core.LiteralMap of node execution inputs. | +| outputs | [UrlBlob](#flyteidl.admin.UrlBlob) | | Signed url to fetch a core.LiteralMap of node execution outputs. | +| full_inputs | [flyteidl.core.LiteralMap](#flyteidl.core.LiteralMap) | | Optional, full_inputs will only be populated if they are under a configured size threshold. | +| full_outputs | [flyteidl.core.LiteralMap](#flyteidl.core.LiteralMap) | | Optional, full_outputs will only be populated if they are under a configured size threshold. | +| dynamic_workflow | [DynamicWorkflowNodeMetadata](#flyteidl.admin.DynamicWorkflowNodeMetadata) | | Optional Workflow closure for a dynamically generated workflow, in the case this node yields a dynamic workflow we return its structure here. | + + + + + + + + +### NodeExecutionGetRequest +A message used to fetch a single node execution entity. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.NodeExecutionIdentifier](#flyteidl.core.NodeExecutionIdentifier) | | Uniquely identifies an individual node execution. | + + + + + + + + +### NodeExecutionList +Request structure to retrieve a list of node execution entities. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| node_executions | [NodeExecution](#flyteidl.admin.NodeExecution) | repeated | | +| token | [string](#string) | | In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty. | + + + + + + + + +### NodeExecutionListRequest +Represents a request structure to retrieve a list of node execution entities. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| workflow_execution_id | [flyteidl.core.WorkflowExecutionIdentifier](#flyteidl.core.WorkflowExecutionIdentifier) | | Indicates the workflow execution to filter by. | +| limit | [uint32](#uint32) | | Indicates the number of resources to be returned. | +| token | [string](#string) | | In the case of multiple pages of results, the, server-provided token can be used to fetch the next page in a query. +optional | +| filters | [string](#string) | | Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional | +| sort_by | [Sort](#flyteidl.admin.Sort) | | Sort ordering. +optional | +| unique_parent_id | [string](#string) | | Unique identifier of the parent node in the execution +optional | + + + + + + + + +### NodeExecutionMetaData +Represents additional attributes related to a Node Execution + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| retry_group | [string](#string) | | Node executions are grouped depending on retries of the parent Retry group is unique within the context of a parent node. | +| is_parent_node | [bool](#bool) | | Boolean flag indicating if the node has child nodes under it | +| spec_node_id | [string](#string) | | Node id of the node in the original workflow This maps to value of WorkflowTemplate.nodes[X].id | + + + + + + + + +### TaskNodeMetadata +Metadata for the case in which the node is a TaskNode + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cache_status | [flyteidl.core.CatalogCacheStatus](#flyteidl.core.CatalogCacheStatus) | | Captures the status of caching for this execution. | +| catalog_key | [flyteidl.core.CatalogMetadata](#flyteidl.core.CatalogMetadata) | | This structure carries the catalog artifact information | + + + + + + + + +### WorkflowNodeMetadata +Metadata for a WorkflowNode + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| executionId | [flyteidl.core.WorkflowExecutionIdentifier](#flyteidl.core.WorkflowExecutionIdentifier) | | | + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/admin/notification.proto + + + + + +### EmailMessage +Represents the Email object that is sent to a publisher/subscriber +to forward the notification. +Note: This is internal to Admin and doesn't need to be exposed to other components. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| recipients_email | [string](#string) | repeated | The list of email addresses to receive an email with the content populated in the other fields. Currently, each email recipient will receive its own email. This populates the TO field. + +[(validate.rules).repeated = {min_items: 1, unique: true, items: {string: {email: true}}}]; | +| sender_email | [string](#string) | | The email of the sender. This populates the FROM field. + +[(validate.rules).string.email = true]; | +| subject_line | [string](#string) | | The content of the subject line. This populates the SUBJECT field. + +[(validate.rules).string.min_len = 1]; | +| body | [string](#string) | | The content of the email body. This populates the BODY field. + +[(validate.rules).string.min_len = 1]; | + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/admin/project.proto + + + + + +### Domain +Namespace within a project commonly used to differentiate between different service instances. +e.g. "production", "development", etc. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| name | [string](#string) | | Display name. | + + + + + + + + +### Project +Top-level namespace used to classify different entities like workflows and executions. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| name | [string](#string) | | Display name. | +| domains | [Domain](#flyteidl.admin.Domain) | repeated | | +| description | [string](#string) | | | +| labels | [Labels](#flyteidl.admin.Labels) | | Leverage Labels from flyteidel.admin.common.proto to tag projects with ownership information. | +| state | [Project.ProjectState](#flyteidl.admin.Project.ProjectState) | | | + + + + + + + + +### ProjectListRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| limit | [uint32](#uint32) | | Indicates the number of projects to be returned. | +| token | [string](#string) | | In the case of multiple pages of results, this server-provided token can be used to fetch the next page in a query. +optional | +| filters | [string](#string) | | Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional | +| sort_by | [Sort](#flyteidl.admin.Sort) | | Sort ordering. +optional | + + + + + + + + +### ProjectRegisterRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| project | [Project](#flyteidl.admin.Project) | | | + + + + + + + + +### ProjectRegisterResponse + + + + + + + + + +### ProjectUpdateResponse + + + + + + + + + +### Projects + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| projects | [Project](#flyteidl.admin.Project) | repeated | | +| token | [string](#string) | | In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty. | + + + + + + + + + + +### Project.ProjectState +The state of the project is used to control its visibility in the UI and validity. + +| Name | Number | Description | +| ---- | ------ | ----------- | +| ACTIVE | 0 | By default, all projects are considered active. | +| ARCHIVED | 1 | Archived projects are no longer visible in the UI and no longer valid. | +| SYSTEM_GENERATED | 2 | System generated projects that aren't explicitly created or managed by a user. | + + + + + + + + + + + +

Top

+ +## flyteidl/admin/project_domain_attributes.proto + + + + + +### ProjectDomainAttributes + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| project | [string](#string) | | Unique project id for which this set of attributes will be applied. | +| domain | [string](#string) | | Unique domain id for which this set of attributes will be applied. | +| matching_attributes | [MatchingAttributes](#flyteidl.admin.MatchingAttributes) | | | + + + + + + + + +### ProjectDomainAttributesDeleteRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| project | [string](#string) | | Unique project id which this set of attributes references. | +| domain | [string](#string) | | Unique domain id which this set of attributes references. | +| resource_type | [MatchableResource](#flyteidl.admin.MatchableResource) | | | + + + + + + + + +### ProjectDomainAttributesDeleteResponse +Purposefully empty, may be populated in the future. + + + + + + + + +### ProjectDomainAttributesGetRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| project | [string](#string) | | Unique project id which this set of attributes references. | +| domain | [string](#string) | | Unique domain id which this set of attributes references. | +| resource_type | [MatchableResource](#flyteidl.admin.MatchableResource) | | | + + + + + + + + +### ProjectDomainAttributesGetResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| attributes | [ProjectDomainAttributes](#flyteidl.admin.ProjectDomainAttributes) | | | + + + + + + + + +### ProjectDomainAttributesUpdateRequest +Sets custom attributes for a project-domain combination. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| attributes | [ProjectDomainAttributes](#flyteidl.admin.ProjectDomainAttributes) | | | + + + + + + + + +### ProjectDomainAttributesUpdateResponse +Purposefully empty, may be populated in the future. + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/admin/schedule.proto + + + + + +### CronSchedule + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| schedule | [string](#string) | | Standard/default cron implementation as described by https://en.wikipedia.org/wiki/Cron#CRON_expression; Also supports nonstandard predefined scheduling definitions as described by https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions except @reboot | +| offset | [string](#string) | | ISO 8601 duration as described by https://en.wikipedia.org/wiki/ISO_8601#Durations | + + + + + + + + +### FixedRate +Option for schedules run at a certain frequency, e.g. every 2 minutes. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| value | [uint32](#uint32) | | | +| unit | [FixedRateUnit](#flyteidl.admin.FixedRateUnit) | | | + + + + + + + + +### Schedule +Defines complete set of information required to trigger an execution on a schedule. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cron_expression | [string](#string) | | **Deprecated.** Uses AWS syntax: "Minutes Hours Day-of-month Month Day-of-week Year" e.g. for a schedule that runs every 15 minutes: "0/15 * * * ? *" | +| rate | [FixedRate](#flyteidl.admin.FixedRate) | | | +| cron_schedule | [CronSchedule](#flyteidl.admin.CronSchedule) | | | +| kickoff_time_input_arg | [string](#string) | | Name of the input variable that the kickoff time will be supplied to when the workflow is kicked off. | + + + + + + + + + + +### FixedRateUnit +Represents a frequency at which to run a schedule. + +| Name | Number | Description | +| ---- | ------ | ----------- | +| MINUTE | 0 | | +| HOUR | 1 | | +| DAY | 2 | | + + + + + + + + + + + +

Top

+ +## flyteidl/admin/task.proto + + + + + +### Task +Flyte workflows are composed of many ordered tasks. That is small, reusable, self-contained logical blocks +arranged to process workflow inputs and produce a deterministic set of outputs. +Tasks can come in many varieties tuned for specialized behavior. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.Identifier](#flyteidl.core.Identifier) | | id represents the unique identifier of the task. | +| closure | [TaskClosure](#flyteidl.admin.TaskClosure) | | closure encapsulates all the fields that maps to a compiled version of the task. | + + + + + + + + +### TaskClosure +Compute task attributes which include values derived from the TaskSpec, as well as plugin-specific data +and task metadata. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| compiled_task | [flyteidl.core.CompiledTask](#flyteidl.core.CompiledTask) | | Represents the compiled representation of the task from the specification provided. | +| created_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | Time at which the task was created. | + + + + + + + + +### TaskCreateRequest +Represents a request structure to create a revision of a task. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.Identifier](#flyteidl.core.Identifier) | | id represents the unique identifier of the task. | +| spec | [TaskSpec](#flyteidl.admin.TaskSpec) | | Represents the specification for task. | + + + + + + + + +### TaskCreateResponse +Represents a response structure if task creation succeeds. + +Purposefully empty, may be populated in the future. + + + + + + + + +### TaskList +Represents a list of tasks returned from the admin. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| tasks | [Task](#flyteidl.admin.Task) | repeated | A list of tasks returned based on the request. | +| token | [string](#string) | | In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty. | + + + + + + + + +### TaskSpec +Represents a structure that encapsulates the user-configured specification of the task. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| template | [flyteidl.core.TaskTemplate](#flyteidl.core.TaskTemplate) | | Template of the task that encapsulates all the metadata of the task. | + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/admin/task_execution.proto + + + + + +### TaskExecution +Encapsulates all details for a single task execution entity. +A task execution represents an instantiated task, including all inputs and additional +metadata as well as computed results included state, outputs, and duration-based attributes. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.TaskExecutionIdentifier](#flyteidl.core.TaskExecutionIdentifier) | | Unique identifier for the task execution. | +| input_uri | [string](#string) | | Path to remote data store where input blob is stored. | +| closure | [TaskExecutionClosure](#flyteidl.admin.TaskExecutionClosure) | | Task execution details and results. | +| is_parent | [bool](#bool) | | Whether this task spawned nodes. | + + + + + + + + +### TaskExecutionClosure +Container for task execution details and results. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| output_uri | [string](#string) | | Path to remote data store where output blob is stored if the execution succeeded (and produced outputs). | +| error | [flyteidl.core.ExecutionError](#flyteidl.core.ExecutionError) | | Error information for the task execution. Populated if the execution failed. | +| phase | [flyteidl.core.TaskExecution.Phase](#flyteidl.core.TaskExecution.Phase) | | The last recorded phase for this task execution. | +| logs | [flyteidl.core.TaskLog](#flyteidl.core.TaskLog) | repeated | Detailed log information output by the task execution. | +| started_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | Time at which the task execution began running. | +| duration | [google.protobuf.Duration](#google.protobuf.Duration) | | The amount of time the task execution spent running. | +| created_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | Time at which the task execution was created. | +| updated_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | Time at which the task execution was last updated. | +| custom_info | [google.protobuf.Struct](#google.protobuf.Struct) | | Custom data specific to the task plugin. | +| reason | [string](#string) | | If there is an explanation for the most recent phase transition, the reason will capture it. | +| task_type | [string](#string) | | A predefined yet extensible Task type identifier. | +| metadata | [flyteidl.event.TaskExecutionMetadata](#flyteidl.event.TaskExecutionMetadata) | | Metadata around how a task was executed. | + + + + + + + + +### TaskExecutionGetDataRequest +Request structure to fetch inputs and output urls for a task execution. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.TaskExecutionIdentifier](#flyteidl.core.TaskExecutionIdentifier) | | The identifier of the task execution for which to fetch inputs and outputs. | + + + + + + + + +### TaskExecutionGetDataResponse +Response structure for TaskExecutionGetDataRequest which contains inputs and outputs for a task execution. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| inputs | [UrlBlob](#flyteidl.admin.UrlBlob) | | Signed url to fetch a core.LiteralMap of task execution inputs. | +| outputs | [UrlBlob](#flyteidl.admin.UrlBlob) | | Signed url to fetch a core.LiteralMap of task execution outputs. | +| full_inputs | [flyteidl.core.LiteralMap](#flyteidl.core.LiteralMap) | | Optional, full_inputs will only be populated if they are under a configured size threshold. | +| full_outputs | [flyteidl.core.LiteralMap](#flyteidl.core.LiteralMap) | | Optional, full_outputs will only be populated if they are under a configured size threshold. | + + + + + + + + +### TaskExecutionGetRequest +A message used to fetch a single task execution entity. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.TaskExecutionIdentifier](#flyteidl.core.TaskExecutionIdentifier) | | Unique identifier for the task execution. | + + + + + + + + +### TaskExecutionList +Response structure for a query to list of task execution entities. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| task_executions | [TaskExecution](#flyteidl.admin.TaskExecution) | repeated | | +| token | [string](#string) | | In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty. | + + + + + + + + +### TaskExecutionListRequest +Represents a request structure to retrieve a list of task execution entities. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| node_execution_id | [flyteidl.core.NodeExecutionIdentifier](#flyteidl.core.NodeExecutionIdentifier) | | Indicates the node execution to filter by. | +| limit | [uint32](#uint32) | | Indicates the number of resources to be returned. | +| token | [string](#string) | | In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. +optional | +| filters | [string](#string) | | Indicates a list of filters passed as string. More info on constructing filters : <Link> +optional | +| sort_by | [Sort](#flyteidl.admin.Sort) | | Sort ordering for returned list. +optional | + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/admin/version.proto + + + + + +### GetVersionRequest +Empty request for GetVersion + + + + + + + + +### GetVersionResponse +Response for the GetVersion API + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| control_plane_version | [Version](#flyteidl.admin.Version) | | The control plane version information. FlyteAdmin and related components form the control plane of Flyte | + + + + + + + + +### Version +Provides Version information for a component + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| Build | [string](#string) | | Specifies the GIT sha of the build | +| Version | [string](#string) | | Version for the build, should follow a semver | +| BuildTime | [string](#string) | | Build timestamp | + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/admin/workflow.proto + + + + + +### Workflow +Represents the workflow structure stored in the Admin +A workflow is created by ordering tasks and associating outputs to inputs +in order to produce a directed-acyclic execution graph. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.Identifier](#flyteidl.core.Identifier) | | id represents the unique identifier of the workflow. | +| closure | [WorkflowClosure](#flyteidl.admin.WorkflowClosure) | | closure encapsulates all the fields that maps to a compiled version of the workflow. | + + + + + + + + +### WorkflowClosure +A container holding the compiled workflow produced from the WorkflowSpec and additional metadata. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| compiled_workflow | [flyteidl.core.CompiledWorkflowClosure](#flyteidl.core.CompiledWorkflowClosure) | | Represents the compiled representation of the workflow from the specification provided. | +| created_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | Time at which the workflow was created. | + + + + + + + + +### WorkflowCreateRequest +Represents a request structure to create a revision of a workflow. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.Identifier](#flyteidl.core.Identifier) | | id represents the unique identifier of the workflow. | +| spec | [WorkflowSpec](#flyteidl.admin.WorkflowSpec) | | Represents the specification for workflow. | + + + + + + + + +### WorkflowCreateResponse +Purposefully empty, may be populated in the future. + + + + + + + + +### WorkflowList +Represents a list of workflows returned from the admin. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| workflows | [Workflow](#flyteidl.admin.Workflow) | repeated | A list of workflows returned based on the request. | +| token | [string](#string) | | In the case of multiple pages of results, the server-provided token can be used to fetch the next page in a query. If there are no more results, this value will be empty. | + + + + + + + + +### WorkflowSpec +Represents a structure that encapsulates the specification of the workflow. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| template | [flyteidl.core.WorkflowTemplate](#flyteidl.core.WorkflowTemplate) | | Template of the task that encapsulates all the metadata of the workflow. | +| sub_workflows | [flyteidl.core.WorkflowTemplate](#flyteidl.core.WorkflowTemplate) | repeated | Workflows that are embedded into other workflows need to be passed alongside the parent workflow to the propeller compiler (since the compiler doesn't have any knowledge of other workflows - ie, it doesn't reach out to Admin to see other registered workflows). In fact, subworkflows do not even need to be registered. | + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/admin/workflow_attributes.proto + + + + + +### WorkflowAttributes + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| project | [string](#string) | | Unique project id for which this set of attributes will be applied. | +| domain | [string](#string) | | Unique domain id for which this set of attributes will be applied. | +| workflow | [string](#string) | | Workflow name for which this set of attributes will be applied. | +| matching_attributes | [MatchingAttributes](#flyteidl.admin.MatchingAttributes) | | | + + + + + + + + +### WorkflowAttributesDeleteRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| project | [string](#string) | | Unique project id which this set of attributes references. | +| domain | [string](#string) | | Unique domain id which this set of attributes references. | +| workflow | [string](#string) | | Workflow name which this set of attributes references. | +| resource_type | [MatchableResource](#flyteidl.admin.MatchableResource) | | | + + + + + + + + +### WorkflowAttributesDeleteResponse +Purposefully empty, may be populated in the future. + + + + + + + + +### WorkflowAttributesGetRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| project | [string](#string) | | Unique project id which this set of attributes references. | +| domain | [string](#string) | | Unique domain id which this set of attributes references. | +| workflow | [string](#string) | | Workflow name which this set of attributes references. | +| resource_type | [MatchableResource](#flyteidl.admin.MatchableResource) | | | + + + + + + + + +### WorkflowAttributesGetResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| attributes | [WorkflowAttributes](#flyteidl.admin.WorkflowAttributes) | | | + + + + + + + + +### WorkflowAttributesUpdateRequest +Sets custom attributes for a project, domain and workflow combination. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| attributes | [WorkflowAttributes](#flyteidl.admin.WorkflowAttributes) | | | + + + + + + + + +### WorkflowAttributesUpdateResponse +Purposefully empty, may be populated in the future. + + + + + + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | float | float | Float | +| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/flyteidl/protos/flyteidl/admin/title.rst b/flyteidl/protos/docs/admin/index.rst similarity index 54% rename from flyteidl/protos/flyteidl/admin/title.rst rename to flyteidl/protos/docs/admin/index.rst index 4b654eda69..cb354d28ac 100644 --- a/flyteidl/protos/flyteidl/admin/title.rst +++ b/flyteidl/protos/docs/admin/index.rst @@ -3,4 +3,12 @@ Flyte Admin Service entities These are the control plane entities that can be used to communication with the Flyte Admin service over gRPC or REST. The endpoint specification is defined in the -`admin service spec `__. + +`Admin service spec `__ + +.. toctree:: + :maxdepth: 1 + :caption: admin + :name: admintoc + + admin diff --git a/flyteidl/protos/docs/core/core.md b/flyteidl/protos/docs/core/core.md new file mode 100644 index 0000000000..0ba63baea9 --- /dev/null +++ b/flyteidl/protos/docs/core/core.md @@ -0,0 +1,2155 @@ +# Protocol Documentation + + +## Table of Contents + +- [flyteidl/core/catalog.proto](#flyteidl/core/catalog.proto) + - [CatalogArtifactTag](#flyteidl.core.CatalogArtifactTag) + - [CatalogMetadata](#flyteidl.core.CatalogMetadata) + + - [CatalogCacheStatus](#flyteidl.core.CatalogCacheStatus) + +- [flyteidl/core/compiler.proto](#flyteidl/core/compiler.proto) + - [CompiledTask](#flyteidl.core.CompiledTask) + - [CompiledWorkflow](#flyteidl.core.CompiledWorkflow) + - [CompiledWorkflowClosure](#flyteidl.core.CompiledWorkflowClosure) + - [ConnectionSet](#flyteidl.core.ConnectionSet) + - [ConnectionSet.DownstreamEntry](#flyteidl.core.ConnectionSet.DownstreamEntry) + - [ConnectionSet.IdList](#flyteidl.core.ConnectionSet.IdList) + - [ConnectionSet.UpstreamEntry](#flyteidl.core.ConnectionSet.UpstreamEntry) + +- [flyteidl/core/condition.proto](#flyteidl/core/condition.proto) + - [BooleanExpression](#flyteidl.core.BooleanExpression) + - [ComparisonExpression](#flyteidl.core.ComparisonExpression) + - [ConjunctionExpression](#flyteidl.core.ConjunctionExpression) + - [Operand](#flyteidl.core.Operand) + + - [ComparisonExpression.Operator](#flyteidl.core.ComparisonExpression.Operator) + - [ConjunctionExpression.LogicalOperator](#flyteidl.core.ConjunctionExpression.LogicalOperator) + +- [flyteidl/core/dynamic_job.proto](#flyteidl/core/dynamic_job.proto) + - [DynamicJobSpec](#flyteidl.core.DynamicJobSpec) + +- [flyteidl/core/errors.proto](#flyteidl/core/errors.proto) + - [ContainerError](#flyteidl.core.ContainerError) + - [ErrorDocument](#flyteidl.core.ErrorDocument) + + - [ContainerError.Kind](#flyteidl.core.ContainerError.Kind) + +- [flyteidl/core/execution.proto](#flyteidl/core/execution.proto) + - [ExecutionError](#flyteidl.core.ExecutionError) + - [NodeExecution](#flyteidl.core.NodeExecution) + - [QualityOfService](#flyteidl.core.QualityOfService) + - [QualityOfServiceSpec](#flyteidl.core.QualityOfServiceSpec) + - [TaskExecution](#flyteidl.core.TaskExecution) + - [TaskLog](#flyteidl.core.TaskLog) + - [WorkflowExecution](#flyteidl.core.WorkflowExecution) + + - [ExecutionError.ErrorKind](#flyteidl.core.ExecutionError.ErrorKind) + - [NodeExecution.Phase](#flyteidl.core.NodeExecution.Phase) + - [QualityOfService.Tier](#flyteidl.core.QualityOfService.Tier) + - [TaskExecution.Phase](#flyteidl.core.TaskExecution.Phase) + - [TaskLog.MessageFormat](#flyteidl.core.TaskLog.MessageFormat) + - [WorkflowExecution.Phase](#flyteidl.core.WorkflowExecution.Phase) + +- [flyteidl/core/identifier.proto](#flyteidl/core/identifier.proto) + - [Identifier](#flyteidl.core.Identifier) + - [NodeExecutionIdentifier](#flyteidl.core.NodeExecutionIdentifier) + - [TaskExecutionIdentifier](#flyteidl.core.TaskExecutionIdentifier) + - [WorkflowExecutionIdentifier](#flyteidl.core.WorkflowExecutionIdentifier) + + - [ResourceType](#flyteidl.core.ResourceType) + +- [flyteidl/core/interface.proto](#flyteidl/core/interface.proto) + - [Parameter](#flyteidl.core.Parameter) + - [ParameterMap](#flyteidl.core.ParameterMap) + - [ParameterMap.ParametersEntry](#flyteidl.core.ParameterMap.ParametersEntry) + - [TypedInterface](#flyteidl.core.TypedInterface) + - [Variable](#flyteidl.core.Variable) + - [VariableMap](#flyteidl.core.VariableMap) + - [VariableMap.VariablesEntry](#flyteidl.core.VariableMap.VariablesEntry) + +- [flyteidl/core/literals.proto](#flyteidl/core/literals.proto) + - [Binary](#flyteidl.core.Binary) + - [Binding](#flyteidl.core.Binding) + - [BindingData](#flyteidl.core.BindingData) + - [BindingDataCollection](#flyteidl.core.BindingDataCollection) + - [BindingDataMap](#flyteidl.core.BindingDataMap) + - [BindingDataMap.BindingsEntry](#flyteidl.core.BindingDataMap.BindingsEntry) + - [Blob](#flyteidl.core.Blob) + - [BlobMetadata](#flyteidl.core.BlobMetadata) + - [KeyValuePair](#flyteidl.core.KeyValuePair) + - [Literal](#flyteidl.core.Literal) + - [LiteralCollection](#flyteidl.core.LiteralCollection) + - [LiteralMap](#flyteidl.core.LiteralMap) + - [LiteralMap.LiteralsEntry](#flyteidl.core.LiteralMap.LiteralsEntry) + - [Primitive](#flyteidl.core.Primitive) + - [RetryStrategy](#flyteidl.core.RetryStrategy) + - [Scalar](#flyteidl.core.Scalar) + - [Schema](#flyteidl.core.Schema) + - [Void](#flyteidl.core.Void) + +- [flyteidl/core/security.proto](#flyteidl/core/security.proto) + - [Identity](#flyteidl.core.Identity) + - [OAuth2Client](#flyteidl.core.OAuth2Client) + - [OAuth2TokenRequest](#flyteidl.core.OAuth2TokenRequest) + - [Secret](#flyteidl.core.Secret) + - [SecurityContext](#flyteidl.core.SecurityContext) + + - [OAuth2TokenRequest.Type](#flyteidl.core.OAuth2TokenRequest.Type) + - [Secret.MountType](#flyteidl.core.Secret.MountType) + +- [flyteidl/core/tasks.proto](#flyteidl/core/tasks.proto) + - [Container](#flyteidl.core.Container) + - [ContainerPort](#flyteidl.core.ContainerPort) + - [DataLoadingConfig](#flyteidl.core.DataLoadingConfig) + - [IOStrategy](#flyteidl.core.IOStrategy) + - [Resources](#flyteidl.core.Resources) + - [Resources.ResourceEntry](#flyteidl.core.Resources.ResourceEntry) + - [RuntimeMetadata](#flyteidl.core.RuntimeMetadata) + - [TaskMetadata](#flyteidl.core.TaskMetadata) + - [TaskTemplate](#flyteidl.core.TaskTemplate) + - [TaskTemplate.ConfigEntry](#flyteidl.core.TaskTemplate.ConfigEntry) + + - [DataLoadingConfig.LiteralMapFormat](#flyteidl.core.DataLoadingConfig.LiteralMapFormat) + - [IOStrategy.DownloadMode](#flyteidl.core.IOStrategy.DownloadMode) + - [IOStrategy.UploadMode](#flyteidl.core.IOStrategy.UploadMode) + - [Resources.ResourceName](#flyteidl.core.Resources.ResourceName) + - [RuntimeMetadata.RuntimeType](#flyteidl.core.RuntimeMetadata.RuntimeType) + +- [flyteidl/core/types.proto](#flyteidl/core/types.proto) + - [BlobType](#flyteidl.core.BlobType) + - [Error](#flyteidl.core.Error) + - [LiteralType](#flyteidl.core.LiteralType) + - [OutputReference](#flyteidl.core.OutputReference) + - [SchemaType](#flyteidl.core.SchemaType) + - [SchemaType.SchemaColumn](#flyteidl.core.SchemaType.SchemaColumn) + + - [BlobType.BlobDimensionality](#flyteidl.core.BlobType.BlobDimensionality) + - [SchemaType.SchemaColumn.SchemaColumnType](#flyteidl.core.SchemaType.SchemaColumn.SchemaColumnType) + - [SimpleType](#flyteidl.core.SimpleType) + +- [flyteidl/core/workflow.proto](#flyteidl/core/workflow.proto) + - [Alias](#flyteidl.core.Alias) + - [BranchNode](#flyteidl.core.BranchNode) + - [IfBlock](#flyteidl.core.IfBlock) + - [IfElseBlock](#flyteidl.core.IfElseBlock) + - [Node](#flyteidl.core.Node) + - [NodeMetadata](#flyteidl.core.NodeMetadata) + - [TaskNode](#flyteidl.core.TaskNode) + - [WorkflowMetadata](#flyteidl.core.WorkflowMetadata) + - [WorkflowMetadataDefaults](#flyteidl.core.WorkflowMetadataDefaults) + - [WorkflowNode](#flyteidl.core.WorkflowNode) + - [WorkflowTemplate](#flyteidl.core.WorkflowTemplate) + + - [WorkflowMetadata.OnFailurePolicy](#flyteidl.core.WorkflowMetadata.OnFailurePolicy) + +- [flyteidl/core/workflow_closure.proto](#flyteidl/core/workflow_closure.proto) + - [WorkflowClosure](#flyteidl.core.WorkflowClosure) + +- [Scalar Value Types](#scalar-value-types) + + + + +

Top

+ +## flyteidl/core/catalog.proto + + + + + +### CatalogArtifactTag + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| artifact_id | [string](#string) | | Artifact ID is generated name | +| name | [string](#string) | | Flyte computes the tag automatically, as the hash of the values | + + + + + + + + +### CatalogMetadata +Catalog artifact information with specific metadata + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| dataset_id | [Identifier](#flyteidl.core.Identifier) | | Dataset ID in the catalog | +| artifact_tag | [CatalogArtifactTag](#flyteidl.core.CatalogArtifactTag) | | Artifact tag in the catalog | +| source_task_execution | [TaskExecutionIdentifier](#flyteidl.core.TaskExecutionIdentifier) | | Today we only support TaskExecutionIdentifier as a source, as catalog caching only works for task executions | + + + + + + + + + + +### CatalogCacheStatus +Indicates the status of CatalogCaching. The reason why this is not embeded in TaskNodeMetadata is, that we may use for other types of nodes as well in the future + +| Name | Number | Description | +| ---- | ------ | ----------- | +| CACHE_DISABLED | 0 | Used to indicate that caching was disabled | +| CACHE_MISS | 1 | Used to indicate that the cache lookup resulted in no matches | +| CACHE_HIT | 2 | used to indicate that the associated artifact was a result of a previous execution | +| CACHE_POPULATED | 3 | used to indicate that the resultant artifact was added to the cache | +| CACHE_LOOKUP_FAILURE | 4 | Used to indicate that cache lookup failed because of an error | +| CACHE_PUT_FAILURE | 5 | Used to indicate that cache lookup failed because of an error | + + + + + + + + + + + +

Top

+ +## flyteidl/core/compiler.proto + + + + + +### CompiledTask +Output of the Compilation step. This object represent one Task. We store more metadata at this layer + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| template | [TaskTemplate](#flyteidl.core.TaskTemplate) | | Completely contained TaskTemplate | + + + + + + + + +### CompiledWorkflow +Output of the compilation Step. This object represents one workflow. We store more metadata at this layer + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| template | [WorkflowTemplate](#flyteidl.core.WorkflowTemplate) | | Completely contained Workflow Template | +| connections | [ConnectionSet](#flyteidl.core.ConnectionSet) | | For internal use only! This field is used by the system and must not be filled in. Any values set will be ignored. | + + + + + + + + +### CompiledWorkflowClosure +A Compiled Workflow Closure contains all the information required to start a new execution, or to visualize a workflow +and its details. The CompiledWorkflowClosure should always contain a primary workflow, that is the main workflow that +will being the execution. All subworkflows are denormalized. WorkflowNodes refer to the workflow identifiers of +compiled subworkflows. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| primary | [CompiledWorkflow](#flyteidl.core.CompiledWorkflow) | | +required | +| sub_workflows | [CompiledWorkflow](#flyteidl.core.CompiledWorkflow) | repeated | Guaranteed that there will only exist one and only one workflow with a given id, i.e., every sub workflow has a unique identifier. Also every enclosed subworkflow is used either by a primary workflow or by a subworkflow as an inlined workflow +optional | +| tasks | [CompiledTask](#flyteidl.core.CompiledTask) | repeated | Guaranteed that there will only exist one and only one task with a given id, i.e., every task has a unique id +required (atleast 1) | + + + + + + + + +### ConnectionSet +Adjacency list for the workflow. This is created as part of the compilation process. Every process after the compilation +step uses this created ConnectionSet + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| downstream | [ConnectionSet.DownstreamEntry](#flyteidl.core.ConnectionSet.DownstreamEntry) | repeated | A list of all the node ids that are downstream from a given node id | +| upstream | [ConnectionSet.UpstreamEntry](#flyteidl.core.ConnectionSet.UpstreamEntry) | repeated | A list of all the node ids, that are upstream of this node id | + + + + + + + + +### ConnectionSet.DownstreamEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [ConnectionSet.IdList](#flyteidl.core.ConnectionSet.IdList) | | | + + + + + + + + +### ConnectionSet.IdList + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| ids | [string](#string) | repeated | | + + + + + + + + +### ConnectionSet.UpstreamEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [ConnectionSet.IdList](#flyteidl.core.ConnectionSet.IdList) | | | + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/core/condition.proto + + + + + +### BooleanExpression +Defines a boolean expression tree. It can be a simple or a conjunction expression. +Multiple expressions can be combined using a conjunction or a disjunction to result in a final boolean result. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| conjunction | [ConjunctionExpression](#flyteidl.core.ConjunctionExpression) | | | +| comparison | [ComparisonExpression](#flyteidl.core.ComparisonExpression) | | | + + + + + + + + +### ComparisonExpression +Defines a 2-level tree where the root is a comparison operator and Operands are primitives or known variables. +Each expression results in a boolean result. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| operator | [ComparisonExpression.Operator](#flyteidl.core.ComparisonExpression.Operator) | | | +| left_value | [Operand](#flyteidl.core.Operand) | | | +| right_value | [Operand](#flyteidl.core.Operand) | | | + + + + + + + + +### ConjunctionExpression +Defines a conjunction expression of two boolean expressions. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| operator | [ConjunctionExpression.LogicalOperator](#flyteidl.core.ConjunctionExpression.LogicalOperator) | | | +| left_expression | [BooleanExpression](#flyteidl.core.BooleanExpression) | | | +| right_expression | [BooleanExpression](#flyteidl.core.BooleanExpression) | | | + + + + + + + + +### Operand +Defines an operand to a comparison expression. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| primitive | [Primitive](#flyteidl.core.Primitive) | | Can be a constant | +| var | [string](#string) | | Or one of this node's input variables | + + + + + + + + + + +### ComparisonExpression.Operator +Binary Operator for each expression + +| Name | Number | Description | +| ---- | ------ | ----------- | +| EQ | 0 | | +| NEQ | 1 | | +| GT | 2 | Greater Than | +| GTE | 3 | | +| LT | 4 | Less Than | +| LTE | 5 | | + + + + + +### ConjunctionExpression.LogicalOperator +Nested conditions. They can be conjoined using AND / OR +Order of evaluation is not important as the operators are Commutative + +| Name | Number | Description | +| ---- | ------ | ----------- | +| AND | 0 | Conjunction | +| OR | 1 | | + + + + + + + + + + + +

Top

+ +## flyteidl/core/dynamic_job.proto + + + + + +### DynamicJobSpec +Describes a set of tasks to execute and how the final outputs are produced. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| nodes | [Node](#flyteidl.core.Node) | repeated | A collection of nodes to execute. | +| min_successes | [int64](#int64) | | An absolute number of successful completions of nodes required to mark this job as succeeded. As soon as this criteria is met, the dynamic job will be marked as successful and outputs will be computed. If this number becomes impossible to reach (e.g. number of currently running tasks + number of already succeeded tasks < min_successes) the task will be aborted immediately and marked as failed. The default value of this field, if not specified, is the count of nodes repeated field. | +| outputs | [Binding](#flyteidl.core.Binding) | repeated | Describes how to bind the final output of the dynamic job from the outputs of executed nodes. The referenced ids in bindings should have the generated id for the subtask. | +| tasks | [TaskTemplate](#flyteidl.core.TaskTemplate) | repeated | [Optional] A complete list of task specs referenced in nodes. | +| subworkflows | [WorkflowTemplate](#flyteidl.core.WorkflowTemplate) | repeated | [Optional] A complete list of task specs referenced in nodes. | + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/core/errors.proto + + + + + +### ContainerError +Error message to propagate detailed errors from container executions to the execution +engine. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| code | [string](#string) | | A simplified code for errors, so that we can provide a glossary of all possible errors. | +| message | [string](#string) | | A detailed error message. | +| kind | [ContainerError.Kind](#flyteidl.core.ContainerError.Kind) | | An abstract error kind for this error. Defaults to Non_Recoverable if not specified. | +| origin | [ExecutionError.ErrorKind](#flyteidl.core.ExecutionError.ErrorKind) | | Defines the origin of the error (system, user, unknown). | + + + + + + + + +### ErrorDocument +Defines the errors.pb file format the container can produce to communicate +failure reasons to the execution engine. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| error | [ContainerError](#flyteidl.core.ContainerError) | | The error raised during execution. | + + + + + + + + + + +### ContainerError.Kind +Defines a generic error type that dictates the behavior of the retry strategy. + +| Name | Number | Description | +| ---- | ------ | ----------- | +| NON_RECOVERABLE | 0 | | +| RECOVERABLE | 1 | | + + + + + + + + + + + +

Top

+ +## flyteidl/core/execution.proto + + + + + +### ExecutionError +Represents the error message from the execution. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| code | [string](#string) | | Error code indicates a grouping of a type of error. More Info: <Link> | +| message | [string](#string) | | Detailed description of the error - including stack trace. | +| error_uri | [string](#string) | | Full error contents accessible via a URI | +| kind | [ExecutionError.ErrorKind](#flyteidl.core.ExecutionError.ErrorKind) | | | + + + + + + + + +### NodeExecution +Indicates various phases of Node Execution + + + + + + + + +### QualityOfService +Indicates the priority of an execution. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| tier | [QualityOfService.Tier](#flyteidl.core.QualityOfService.Tier) | | | +| spec | [QualityOfServiceSpec](#flyteidl.core.QualityOfServiceSpec) | | | + + + + + + + + +### QualityOfServiceSpec +Represents customized execution run-time attributes. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| queueing_budget | [google.protobuf.Duration](#google.protobuf.Duration) | | Indicates how much queueing delay an execution can tolerate. | + + + + + + + + +### TaskExecution +Phases that task plugins can go through. Not all phases may be applicable to a specific plugin task, +but this is the cumulative list that customers may want to know about for their task. + + + + + + + + +### TaskLog +Log information for the task that is specific to a log sink +When our log story is flushed out, we may have more metadata here like log link expiry + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| uri | [string](#string) | | | +| name | [string](#string) | | | +| message_format | [TaskLog.MessageFormat](#flyteidl.core.TaskLog.MessageFormat) | | | +| ttl | [google.protobuf.Duration](#google.protobuf.Duration) | | | + + + + + + + + +### WorkflowExecution +Indicates various phases of Workflow Execution + + + + + + + + + + +### ExecutionError.ErrorKind +Error type: System or User + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNKNOWN | 0 | | +| USER | 1 | | +| SYSTEM | 2 | | + + + + + +### NodeExecution.Phase + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNDEFINED | 0 | | +| QUEUED | 1 | | +| RUNNING | 2 | | +| SUCCEEDED | 3 | | +| FAILING | 4 | | +| FAILED | 5 | | +| ABORTED | 6 | | +| SKIPPED | 7 | | +| TIMED_OUT | 8 | | +| DYNAMIC_RUNNING | 9 | | + + + + + +### QualityOfService.Tier + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNDEFINED | 0 | Default: no quality of service specified. | +| HIGH | 1 | | +| MEDIUM | 2 | | +| LOW | 3 | | + + + + + +### TaskExecution.Phase + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNDEFINED | 0 | | +| QUEUED | 1 | | +| RUNNING | 2 | | +| SUCCEEDED | 3 | | +| ABORTED | 4 | | +| FAILED | 5 | | +| INITIALIZING | 6 | To indicate cases where task is initializing, like: ErrImagePull, ContainerCreating, PodInitializing | +| WAITING_FOR_RESOURCES | 7 | To address cases, where underlying resource is not available: Backoff error, Resource quota exceeded | + + + + + +### TaskLog.MessageFormat + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNKNOWN | 0 | | +| CSV | 1 | | +| JSON | 2 | | + + + + + +### WorkflowExecution.Phase + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNDEFINED | 0 | | +| QUEUED | 1 | | +| RUNNING | 2 | | +| SUCCEEDING | 3 | | +| SUCCEEDED | 4 | | +| FAILING | 5 | | +| FAILED | 6 | | +| ABORTED | 7 | | +| TIMED_OUT | 8 | | + + + + + + + + + + + +

Top

+ +## flyteidl/core/identifier.proto + + + + + +### Identifier +Encapsulation of fields that uniquely identifies a Flyte resource. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| resource_type | [ResourceType](#flyteidl.core.ResourceType) | | Identifies the specific type of resource that this identifer corresponds to. | +| project | [string](#string) | | Name of the project the resource belongs to. | +| domain | [string](#string) | | Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project. | +| name | [string](#string) | | User provided value for the resource. | +| version | [string](#string) | | Specific version of the resource. | + + + + + + + + +### NodeExecutionIdentifier +Encapsulation of fields that identify a Flyte node execution entity. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| node_id | [string](#string) | | | +| execution_id | [WorkflowExecutionIdentifier](#flyteidl.core.WorkflowExecutionIdentifier) | | | + + + + + + + + +### TaskExecutionIdentifier +Encapsulation of fields that identify a Flyte task execution entity. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| task_id | [Identifier](#flyteidl.core.Identifier) | | | +| node_execution_id | [NodeExecutionIdentifier](#flyteidl.core.NodeExecutionIdentifier) | | | +| retry_attempt | [uint32](#uint32) | | | + + + + + + + + +### WorkflowExecutionIdentifier +Encapsulation of fields that uniquely identifies a Flyte workflow execution + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| project | [string](#string) | | Name of the project the resource belongs to. | +| domain | [string](#string) | | Name of the domain the resource belongs to. A domain can be considered as a subset within a specific project. | +| name | [string](#string) | | User or system provided value for the resource. | + + + + + + + + + + +### ResourceType +Indicates a resource type within Flyte. + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNSPECIFIED | 0 | | +| TASK | 1 | | +| WORKFLOW | 2 | | +| LAUNCH_PLAN | 3 | | +| DATASET | 4 | A dataset represents an entity modeled in Flyte DataCatalog. A Dataset is also a versioned entity and can be a compilation of multiple individual objects. Eventually all Catalog objects should be modeled similar to Flyte Objects. The Dataset entities makes it possible for the UI and CLI to act on the objects in a similar manner to other Flyte objects | + + + + + + + + + + + +

Top

+ +## flyteidl/core/interface.proto + + + + + +### Parameter +A parameter is used as input to a launch plan and has +the special ability to have a default value or mark itself as required. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| var | [Variable](#flyteidl.core.Variable) | | +required Variable. Defines the type of the variable backing this parameter. | +| default | [Literal](#flyteidl.core.Literal) | | Defines a default value that has to match the variable type defined. | +| required | [bool](#bool) | | +optional, is this value required to be filled. | + + + + + + + + +### ParameterMap +A map of Parameters. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| parameters | [ParameterMap.ParametersEntry](#flyteidl.core.ParameterMap.ParametersEntry) | repeated | Defines a map of parameter names to parameters. | + + + + + + + + +### ParameterMap.ParametersEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [Parameter](#flyteidl.core.Parameter) | | | + + + + + + + + +### TypedInterface +Defines strongly typed inputs and outputs. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| inputs | [VariableMap](#flyteidl.core.VariableMap) | | | +| outputs | [VariableMap](#flyteidl.core.VariableMap) | | | + + + + + + + + +### Variable +Defines a strongly typed variable. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [LiteralType](#flyteidl.core.LiteralType) | | Variable literal type. | +| description | [string](#string) | | +optional string describing input variable | + + + + + + + + +### VariableMap +A map of Variables + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| variables | [VariableMap.VariablesEntry](#flyteidl.core.VariableMap.VariablesEntry) | repeated | Defines a map of variable names to variables. | + + + + + + + + +### VariableMap.VariablesEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [Variable](#flyteidl.core.Variable) | | | + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/core/literals.proto + + + + + +### Binary +A simple byte array with a tag to help different parts of the system communicate about what is in the byte array. +It's strongly advisable that consumers of this type define a unique tag and validate the tag before parsing the data. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| value | [bytes](#bytes) | | | +| tag | [string](#string) | | | + + + + + + + + +### Binding +An input/output binding of a variable to either static value or a node output. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| var | [string](#string) | | Variable name must match an input/output variable of the node. | +| binding | [BindingData](#flyteidl.core.BindingData) | | Data to use to bind this variable. | + + + + + + + + +### BindingData +Specifies either a simple value or a reference to another output. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| scalar | [Scalar](#flyteidl.core.Scalar) | | A simple scalar value. | +| collection | [BindingDataCollection](#flyteidl.core.BindingDataCollection) | | A collection of binding data. This allows nesting of binding data to any number of levels. | +| promise | [OutputReference](#flyteidl.core.OutputReference) | | References an output promised by another node. | +| map | [BindingDataMap](#flyteidl.core.BindingDataMap) | | A map of bindings. The key is always a string. | + + + + + + + + +### BindingDataCollection +A collection of BindingData items. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| bindings | [BindingData](#flyteidl.core.BindingData) | repeated | | + + + + + + + + +### BindingDataMap +A map of BindingData items. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| bindings | [BindingDataMap.BindingsEntry](#flyteidl.core.BindingDataMap.BindingsEntry) | repeated | | + + + + + + + + +### BindingDataMap.BindingsEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [BindingData](#flyteidl.core.BindingData) | | | + + + + + + + + +### Blob +Refers to an offloaded set of files. It encapsulates the type of the store and a unique uri for where the data is. +There are no restrictions on how the uri is formatted since it will depend on how to interact with the store. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| metadata | [BlobMetadata](#flyteidl.core.BlobMetadata) | | | +| uri | [string](#string) | | | + + + + + + + + +### BlobMetadata + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [BlobType](#flyteidl.core.BlobType) | | | + + + + + + + + +### KeyValuePair +A generic key value pair. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | required. | +| value | [string](#string) | | +optional. | + + + + + + + + +### Literal +A simple value. This supports any level of nesting (e.g. array of array of array of Blobs) as well as simple primitives. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| scalar | [Scalar](#flyteidl.core.Scalar) | | A simple value. | +| collection | [LiteralCollection](#flyteidl.core.LiteralCollection) | | A collection of literals to allow nesting. | +| map | [LiteralMap](#flyteidl.core.LiteralMap) | | A map of strings to literals. | + + + + + + + + +### LiteralCollection +A collection of literals. This is a workaround since oneofs in proto messages cannot contain a repeated field. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| literals | [Literal](#flyteidl.core.Literal) | repeated | | + + + + + + + + +### LiteralMap +A map of literals. This is a workaround since oneofs in proto messages cannot contain a repeated field. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| literals | [LiteralMap.LiteralsEntry](#flyteidl.core.LiteralMap.LiteralsEntry) | repeated | | + + + + + + + + +### LiteralMap.LiteralsEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [Literal](#flyteidl.core.Literal) | | | + + + + + + + + +### Primitive +Primitive Types + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| integer | [int64](#int64) | | | +| float_value | [double](#double) | | | +| string_value | [string](#string) | | | +| boolean | [bool](#bool) | | | +| datetime | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | | +| duration | [google.protobuf.Duration](#google.protobuf.Duration) | | | + + + + + + + + +### RetryStrategy +Retry strategy associated with an executable unit. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| retries | [uint32](#uint32) | | Number of retries. Retries will be consumed when the job fails with a recoverable error. The number of retries must be less than or equals to 10. | + + + + + + + + +### Scalar + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| primitive | [Primitive](#flyteidl.core.Primitive) | | | +| blob | [Blob](#flyteidl.core.Blob) | | | +| binary | [Binary](#flyteidl.core.Binary) | | | +| schema | [Schema](#flyteidl.core.Schema) | | | +| none_type | [Void](#flyteidl.core.Void) | | | +| error | [Error](#flyteidl.core.Error) | | | +| generic | [google.protobuf.Struct](#google.protobuf.Struct) | | | + + + + + + + + +### Schema +A strongly typed schema that defines the interface of data retrieved from the underlying storage medium. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| uri | [string](#string) | | | +| type | [SchemaType](#flyteidl.core.SchemaType) | | | + + + + + + + + +### Void +Used to denote a nil/null/None assignment to a scalar value. The underlying LiteralType for Void is intentionally +undefined since it can be assigned to a scalar of any LiteralType. + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/core/security.proto + + + + + +### Identity +Identity encapsulates the various security identities a task can run as. It's up to the underlying plugin to pick the +right identity for the execution environment. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| iam_role | [string](#string) | | iam_role references the fully qualified name of Identity & Access Management role to impersonate. | +| k8s_service_account | [string](#string) | | k8s_service_account references a kubernetes service account to impersonate. | +| oauth2_client | [OAuth2Client](#flyteidl.core.OAuth2Client) | | oauth2_client references an oauth2 client. Backend plugins can use this information to impersonate the client when making external calls. | + + + + + + + + +### OAuth2Client +OAuth2Client encapsulates OAuth2 Client Credentials to be used when making calls on behalf of that task. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| client_id | [string](#string) | | client_id is the public id for the client to use. The system will not perform any pre-auth validation that the secret requested matches the client_id indicated here. +required | +| client_secret | [Secret](#flyteidl.core.Secret) | | client_secret is a reference to the secret used to authenticate the OAuth2 client. +required | + + + + + + + + +### OAuth2TokenRequest +OAuth2TokenRequest encapsulates information needed to request an OAuth2 token. +FLYTE_TOKENS_ENV_PREFIX will be passed to indicate the prefix of the environment variables that will be present if +tokens are passed through environment variables. +FLYTE_TOKENS_PATH_PREFIX will be passed to indicate the prefix of the path where secrets will be mounted if tokens +are passed through file mounts. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | name indicates a unique id for the token request within this task token requests. It'll be used as a suffix for environment variables and as a filename for mounting tokens as files. +required | +| type | [OAuth2TokenRequest.Type](#flyteidl.core.OAuth2TokenRequest.Type) | | type indicates the type of the request to make. Defaults to CLIENT_CREDENTIALS. +required | +| client | [OAuth2Client](#flyteidl.core.OAuth2Client) | | client references the client_id/secret to use to request the OAuth2 token. +required | +| idp_discovery_endpoint | [string](#string) | | idp_discovery_endpoint references the discovery endpoint used to retrieve token endpoint and other related information. +optional | +| token_endpoint | [string](#string) | | token_endpoint references the token issuance endpoint. If idp_discovery_endpoint is not provided, this parameter is mandatory. +optional | + + + + + + + + +### Secret +Secret encapsulates information about the secret a task needs to proceed. An environment variable +FLYTE_SECRETS_ENV_PREFIX will be passed to indicate the prefix of the environment variables that will be present if +secrets are passed through environment variables. +FLYTE_SECRETS_DEFAULT_DIR will be passed to indicate the prefix of the path where secrets will be mounted if secrets +are passed through file mounts. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| group | [string](#string) | | The name of the secret group where to find the key referenced below. For K8s secrets, this should be the name of the v1/secret object. For Confidant, this should be the Credential name. For Vault, this should be the secret name. For AWS Secret Manager, this should be the name of the secret. +required | +| group_version | [string](#string) | | The group version to fetch. This is not supported in all secret management systems. It'll be ignored for the ones that do not support it. +optional | +| key | [string](#string) | | The name of the secret to mount. This has to match an existing secret in the system. It's up to the implementation of the secret management system to require case sensitivity. For K8s secrets, Confidant and Vault, this should match one of the keys inside the secret. For AWS Secret Manager, it's ignored. +optional | +| mount_requirement | [Secret.MountType](#flyteidl.core.Secret.MountType) | | mount_requirement is optional. Indicates where the secret has to be mounted. If provided, the execution will fail if the underlying key management system cannot satisfy that requirement. If not provided, the default location will depend on the key management system. +optional | + + + + + + + + +### SecurityContext +SecurityContext holds security attributes that apply to tasks. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| run_as | [Identity](#flyteidl.core.Identity) | | run_as encapsulates the identity a pod should run as. If the task fills in multiple fields here, it'll be up to the backend plugin to choose the appropriate identity for the execution engine the task will run on. | +| secrets | [Secret](#flyteidl.core.Secret) | repeated | secrets indicate the list of secrets the task needs in order to proceed. Secrets will be mounted/passed to the pod as it starts. If the plugin responsible for kicking of the task will not run it on a flyte cluster (e.g. AWS Batch), it's the responsibility of the plugin to fetch the secret (which means propeller identity will need access to the secret) and to pass it to the remote execution engine. | +| tokens | [OAuth2TokenRequest](#flyteidl.core.OAuth2TokenRequest) | repeated | tokens indicate the list of token requests the task needs in order to proceed. Tokens will be mounted/passed to the pod as it starts. If the plugin responsible for kicking of the task will not run it on a flyte cluster (e.g. AWS Batch), it's the responsibility of the plugin to fetch the secret (which means propeller identity will need access to the secret) and to pass it to the remote execution engine. | + + + + + + + + + + +### OAuth2TokenRequest.Type +Type of the token requested. + +| Name | Number | Description | +| ---- | ------ | ----------- | +| CLIENT_CREDENTIALS | 0 | CLIENT_CREDENTIALS indicates a 2-legged OAuth token requested using client credentials. | + + + + + +### Secret.MountType + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| ANY | 0 | Default case, indicates the client can tolerate either mounting options. | +| ENV_VAR | 1 | ENV_VAR indicates the secret needs to be mounted as an environment variable. | +| FILE | 2 | FILE indicates the secret needs to be mounted as a file. | + + + + + + + + + + + +

Top

+ +## flyteidl/core/tasks.proto + + + + + +### Container + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| image | [string](#string) | | Container image url. Eg: docker/redis:latest | +| command | [string](#string) | repeated | Command to be executed, if not provided, the default entrypoint in the container image will be used. | +| args | [string](#string) | repeated | These will default to Flyte given paths. If provided, the system will not append known paths. If the task still needs flyte's inputs and outputs path, add $(FLYTE_INPUT_FILE), $(FLYTE_OUTPUT_FILE) wherever makes sense and the system will populate these before executing the container. | +| resources | [Resources](#flyteidl.core.Resources) | | Container resources requirement as specified by the container engine. | +| env | [KeyValuePair](#flyteidl.core.KeyValuePair) | repeated | Environment variables will be set as the container is starting up. | +| config | [KeyValuePair](#flyteidl.core.KeyValuePair) | repeated | **Deprecated.** Allows extra configs to be available for the container. TODO: elaborate on how configs will become available. Deprecated, please use TaskTemplate.config instead. | +| ports | [ContainerPort](#flyteidl.core.ContainerPort) | repeated | Ports to open in the container. This feature is not supported by all execution engines. (e.g. supported on K8s but not supported on AWS Batch) Only K8s | +| data_config | [DataLoadingConfig](#flyteidl.core.DataLoadingConfig) | | BETA: Optional configuration for DataLoading. If not specified, then default values are used. This makes it possible to to run a completely portable container, that uses inputs and outputs only from the local file-system and without having any reference to flyteidl. This is supported only on K8s at the moment. If data loading is enabled, then data will be mounted in accompanying directories specified in the DataLoadingConfig. If the directories are not specified, inputs will be mounted onto and outputs will be uploaded from a pre-determined file-system path. Refer to the documentation to understand the default paths. Only K8s | + + + + + + + + +### ContainerPort +Defines port properties for a container. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| container_port | [uint32](#uint32) | | Number of port to expose on the pod's IP address. This must be a valid port number, 0 < x < 65536. | + + + + + + + + +### DataLoadingConfig +This configuration allows executing raw containers in Flyte using the Flyte CoPilot system. +Flyte CoPilot, eliminates the needs of flytekit or sdk inside the container. Any inputs required by the users container are side-loaded in the input_path +Any outputs generated by the user container - within output_path are automatically uploaded. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| enabled | [bool](#bool) | | Flag enables DataLoading Config. If this is not set, data loading will not be used! | +| input_path | [string](#string) | | File system path (start at root). This folder will contain all the inputs exploded to a separate file. Example, if the input interface needs (x: int, y: blob, z: multipart_blob) and the input path is "/var/flyte/inputs", then the file system will look like /var/flyte/inputs/inputs.<metadata format dependent -> .pb .json .yaml> -> Format as defined previously. The Blob and Multipart blob will reference local filesystem instead of remote locations /var/flyte/inputs/x -> X is a file that contains the value of x (integer) in string format /var/flyte/inputs/y -> Y is a file in Binary format /var/flyte/inputs/z/... -> Note Z itself is a directory More information about the protocol - refer to docs #TODO reference docs here | +| output_path | [string](#string) | | File system path (start at root). This folder should contain all the outputs for the task as individual files and/or an error text file | +| format | [DataLoadingConfig.LiteralMapFormat](#flyteidl.core.DataLoadingConfig.LiteralMapFormat) | | In the inputs folder, there will be an additional summary/metadata file that contains references to all files or inlined primitive values. This format decides the actual encoding for the data. Refer to the encoding to understand the specifics of the contents and the encoding | +| io_strategy | [IOStrategy](#flyteidl.core.IOStrategy) | | | + + + + + + + + +### IOStrategy +Strategy to use when dealing with Blob, Schema, or multipart blob data (large datasets) + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| download_mode | [IOStrategy.DownloadMode](#flyteidl.core.IOStrategy.DownloadMode) | | Mode to use to manage downloads | +| upload_mode | [IOStrategy.UploadMode](#flyteidl.core.IOStrategy.UploadMode) | | Mode to use to manage uploads | + + + + + + + + +### Resources +A customizable interface to convey resources requested for a container. This can be interpretted differently for different +container engines. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| requests | [Resources.ResourceEntry](#flyteidl.core.Resources.ResourceEntry) | repeated | The desired set of resources requested. ResourceNames must be unique within the list. | +| limits | [Resources.ResourceEntry](#flyteidl.core.Resources.ResourceEntry) | repeated | Defines a set of bounds (e.g. min/max) within which the task can reliably run. ResourceNames must be unique within the list. | + + + + + + + + +### Resources.ResourceEntry +Encapsulates a resource name and value. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [Resources.ResourceName](#flyteidl.core.Resources.ResourceName) | | Resource name. | +| value | [string](#string) | | Value must be a valid k8s quantity. See https://github.com/kubernetes/apimachinery/blob/master/pkg/api/resource/quantity.go#L30-L80 | + + + + + + + + +### RuntimeMetadata +Runtime information. This is losely defined to allow for extensibility. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| type | [RuntimeMetadata.RuntimeType](#flyteidl.core.RuntimeMetadata.RuntimeType) | | Type of runtime. | +| version | [string](#string) | | Version of the runtime. All versions should be backward compatible. However, certain cases call for version checks to ensure tighter validation or setting expectations. | +| flavor | [string](#string) | | +optional It can be used to provide extra information about the runtime (e.g. python, golang... etc.). | + + + + + + + + +### TaskMetadata +Task Metadata + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| discoverable | [bool](#bool) | | Indicates whether the system should attempt to lookup this task's output to avoid duplication of work. | +| runtime | [RuntimeMetadata](#flyteidl.core.RuntimeMetadata) | | Runtime information about the task. | +| timeout | [google.protobuf.Duration](#google.protobuf.Duration) | | The overall timeout of a task including user-triggered retries. | +| retries | [RetryStrategy](#flyteidl.core.RetryStrategy) | | Number of retries per task. | +| discovery_version | [string](#string) | | Indicates a logical version to apply to this task for the purpose of discovery. | +| deprecated_error_message | [string](#string) | | If set, this indicates that this task is deprecated. This will enable owners of tasks to notify consumers of the ending of support for a given task. | +| interruptible | [bool](#bool) | | | + + + + + + + + +### TaskTemplate +A Task structure that uniquely identifies a task in the system +Tasks are registered as a first step in the system. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [Identifier](#flyteidl.core.Identifier) | | Auto generated taskId by the system. Task Id uniquely identifies this task globally. | +| type | [string](#string) | | A predefined yet extensible Task type identifier. This can be used to customize any of the components. If no extensions are provided in the system, Flyte will resolve the this task to its TaskCategory and default the implementation registered for the TaskCategory. | +| metadata | [TaskMetadata](#flyteidl.core.TaskMetadata) | | Extra metadata about the task. | +| interface | [TypedInterface](#flyteidl.core.TypedInterface) | | A strongly typed interface for the task. This enables others to use this task within a workflow and gauarantees compile-time validation of the workflow to avoid costly runtime failures. | +| custom | [google.protobuf.Struct](#google.protobuf.Struct) | | Custom data about the task. This is extensible to allow various plugins in the system. | +| container | [Container](#flyteidl.core.Container) | | | +| task_type_version | [int32](#int32) | | This can be used to customize task handling at execution time for the same task type. | +| security_context | [SecurityContext](#flyteidl.core.SecurityContext) | | security_context encapsulates security attributes requested to run this task. | +| config | [TaskTemplate.ConfigEntry](#flyteidl.core.TaskTemplate.ConfigEntry) | repeated | Metadata about the custom defined for this task. This is extensible to allow various plugins in the system to use as required. reserve the field numbers 1 through 15 for very frequently occurring message elements | + + + + + + + + +### TaskTemplate.ConfigEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + + + + + + + + +### DataLoadingConfig.LiteralMapFormat +LiteralMapFormat decides the encoding format in which the input metadata should be made available to the containers. +If the user has access to the protocol buffer definitions, it is recommended to use the PROTO format. +JSON and YAML do not need any protobuf definitions to read it +All remote references in core.LiteralMap are replaced with local filesystem references (the data is downloaded to local filesystem) + +| Name | Number | Description | +| ---- | ------ | ----------- | +| JSON | 0 | JSON / YAML for the metadata (which contains inlined primitive values). The representation is inline with the standard json specification as specified - https://www.json.org/json-en.html | +| YAML | 1 | | +| PROTO | 2 | Proto is a serialized binary of `core.LiteralMap` defined in flyteidl/core | + + + + + +### IOStrategy.DownloadMode +Mode to use for downloading + +| Name | Number | Description | +| ---- | ------ | ----------- | +| DOWNLOAD_EAGER | 0 | All data will be downloaded before the main container is executed | +| DOWNLOAD_STREAM | 1 | Data will be downloaded as a stream and an End-Of-Stream marker will be written to indicate all data has been downloaded. Refer to protocol for details | +| DO_NOT_DOWNLOAD | 2 | Large objects (offloaded) will not be downloaded | + + + + + +### IOStrategy.UploadMode +Mode to use for uploading + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UPLOAD_ON_EXIT | 0 | All data will be uploaded after the main container exits | +| UPLOAD_EAGER | 1 | Data will be uploaded as it appears. Refer to protocol specification for details | +| DO_NOT_UPLOAD | 2 | Data will not be uploaded, only references will be written | + + + + + +### Resources.ResourceName +Known resource names. + +| Name | Number | Description | +| ---- | ------ | ----------- | +| UNKNOWN | 0 | | +| CPU | 1 | | +| GPU | 2 | | +| MEMORY | 3 | | +| STORAGE | 4 | | + + + + + +### RuntimeMetadata.RuntimeType + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| OTHER | 0 | | +| FLYTE_SDK | 1 | | + + + + + + + + + + + +

Top

+ +## flyteidl/core/types.proto + + + + + +### BlobType +Defines type behavior for blob objects + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| format | [string](#string) | | Format can be a free form string understood by SDK/UI etc like csv, parquet etc | +| dimensionality | [BlobType.BlobDimensionality](#flyteidl.core.BlobType.BlobDimensionality) | | | + + + + + + + + +### Error +Represents an error thrown from a node. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| failed_node_id | [string](#string) | | The node id that threw the error. | +| message | [string](#string) | | Error message thrown. | + + + + + + + + +### LiteralType +Defines a strong type to allow type checking between interfaces. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| simple | [SimpleType](#flyteidl.core.SimpleType) | | A simple type that can be compared one-to-one with another. | +| schema | [SchemaType](#flyteidl.core.SchemaType) | | A complex type that requires matching of inner fields. | +| collection_type | [LiteralType](#flyteidl.core.LiteralType) | | Defines the type of the value of a collection. Only homogeneous collections are allowed. | +| map_value_type | [LiteralType](#flyteidl.core.LiteralType) | | Defines the type of the value of a map type. The type of the key is always a string. | +| blob | [BlobType](#flyteidl.core.BlobType) | | A blob might have specialized implementation details depending on associated metadata. | +| metadata | [google.protobuf.Struct](#google.protobuf.Struct) | | This field contains type metadata that is descriptive of the type, but is NOT considered in type-checking. This might be used by consumers to identify special behavior or display extended information for the type. | + + + + + + + + +### OutputReference +A reference to an output produced by a node. The type can be retrieved -and validated- from +the underlying interface of the node. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| node_id | [string](#string) | | Node id must exist at the graph layer. | +| var | [string](#string) | | Variable name must refer to an output variable for the node. | + + + + + + + + +### SchemaType +Defines schema columns and types to strongly type-validate schemas interoperability. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| columns | [SchemaType.SchemaColumn](#flyteidl.core.SchemaType.SchemaColumn) | repeated | A list of ordered columns this schema comprises of. | + + + + + + + + +### SchemaType.SchemaColumn + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | A unique name -within the schema type- for the column | +| type | [SchemaType.SchemaColumn.SchemaColumnType](#flyteidl.core.SchemaType.SchemaColumn.SchemaColumnType) | | The column type. This allows a limited set of types currently. | + + + + + + + + + + +### BlobType.BlobDimensionality + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| SINGLE | 0 | | +| MULTIPART | 1 | | + + + + + +### SchemaType.SchemaColumn.SchemaColumnType + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| INTEGER | 0 | | +| FLOAT | 1 | | +| STRING | 2 | | +| BOOLEAN | 3 | | +| DATETIME | 4 | | +| DURATION | 5 | | + + + + + +### SimpleType +Define a set of simple types. + +| Name | Number | Description | +| ---- | ------ | ----------- | +| NONE | 0 | | +| INTEGER | 1 | | +| FLOAT | 2 | | +| STRING | 3 | | +| BOOLEAN | 4 | | +| DATETIME | 5 | | +| DURATION | 6 | | +| BINARY | 7 | | +| ERROR | 8 | | +| STRUCT | 9 | | + + + + + + + + + + + +

Top

+ +## flyteidl/core/workflow.proto + + + + + +### Alias +Links a variable to an alias. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| var | [string](#string) | | Must match one of the output variable names on a node. | +| alias | [string](#string) | | A workflow-level unique alias that downstream nodes can refer to in their input. | + + + + + + + + +### BranchNode +BranchNode is a special node that alter the flow of the workflow graph. It allows the control flow to branch at +runtime based on a series of conditions that get evaluated on various parameters (e.g. inputs, primtives). + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| if_else | [IfElseBlock](#flyteidl.core.IfElseBlock) | | +required | + + + + + + + + +### IfBlock +Defines a condition and the execution unit that should be executed if the condition is satisfied. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| condition | [BooleanExpression](#flyteidl.core.BooleanExpression) | | | +| then_node | [Node](#flyteidl.core.Node) | | | + + + + + + + + +### IfElseBlock +Defines a series of if/else blocks. The first branch whose condition evaluates to true is the one to execute. +If no conditions were satisfied, the else_node or the error will execute. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| case | [IfBlock](#flyteidl.core.IfBlock) | | +required. First condition to evaluate. | +| other | [IfBlock](#flyteidl.core.IfBlock) | repeated | +optional. Additional branches to evaluate. | +| else_node | [Node](#flyteidl.core.Node) | | The node to execute in case none of the branches were taken. | +| error | [Error](#flyteidl.core.Error) | | An error to throw in case none of the branches were taken. | + + + + + + + + +### Node +A Workflow graph Node. One unit of execution in the graph. Each node can be linked to a Task, a Workflow or a branch +node. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | A workflow-level unique identifier that identifies this node in the workflow. "inputs" and "outputs" are reserved node ids that cannot be used by other nodes. | +| metadata | [NodeMetadata](#flyteidl.core.NodeMetadata) | | Extra metadata about the node. | +| inputs | [Binding](#flyteidl.core.Binding) | repeated | Specifies how to bind the underlying interface's inputs. All required inputs specified in the underlying interface must be fullfilled. | +| upstream_node_ids | [string](#string) | repeated | +optional Specifies execution depdendency for this node ensuring it will only get scheduled to run after all its upstream nodes have completed. This node will have an implicit depdendency on any node that appears in inputs field. | +| output_aliases | [Alias](#flyteidl.core.Alias) | repeated | +optional. A node can define aliases for a subset of its outputs. This is particularly useful if different nodes need to conform to the same interface (e.g. all branches in a branch node). Downstream nodes must refer to this nodes outputs using the alias if one's specified. | +| task_node | [TaskNode](#flyteidl.core.TaskNode) | | Information about the Task to execute in this node. | +| workflow_node | [WorkflowNode](#flyteidl.core.WorkflowNode) | | Information about the Workflow to execute in this mode. | +| branch_node | [BranchNode](#flyteidl.core.BranchNode) | | Information about the branch node to evaluate in this node. | + + + + + + + + +### NodeMetadata +Defines extra information about the Node. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | A friendly name for the Node | +| timeout | [google.protobuf.Duration](#google.protobuf.Duration) | | The overall timeout of a task. | +| retries | [RetryStrategy](#flyteidl.core.RetryStrategy) | | Number of retries per task. | +| interruptible | [bool](#bool) | | | + + + + + + + + +### TaskNode +Refers to the task that the Node is to execute. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| reference_id | [Identifier](#flyteidl.core.Identifier) | | A globally unique identifier for the task. | + + + + + + + + +### WorkflowMetadata +This is workflow layer metadata. These settings are only applicable to the workflow as a whole, and do not +percolate down to child entities (like tasks) launched by the workflow. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| quality_of_service | [QualityOfService](#flyteidl.core.QualityOfService) | | Indicates the runtime priority of workflow executions. | +| on_failure | [WorkflowMetadata.OnFailurePolicy](#flyteidl.core.WorkflowMetadata.OnFailurePolicy) | | Defines how the system should behave when a failure is detected in the workflow execution. | + + + + + + + + +### WorkflowMetadataDefaults +The difference between these settings and the WorkflowMetadata ones is that these are meant to be passed down to +a workflow's underlying entities (like tasks). For instance, 'interruptible' has no meaning at the workflow layer, it +is only relevant when a task executes. The settings here are the defaults that are passed to all nodes +unless explicitly overridden at the node layer. +If you are adding a setting that applies to both the Workflow itself, and everything underneath it, it should be +added to both this object and the WorkflowMetadata object above. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| interruptible | [bool](#bool) | | Whether child nodes of the workflow are interruptible. | + + + + + + + + +### WorkflowNode +Refers to a the workflow the node is to execute. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| launchplan_ref | [Identifier](#flyteidl.core.Identifier) | | A globally unique identifier for the launch plan. | +| sub_workflow_ref | [Identifier](#flyteidl.core.Identifier) | | Reference to a subworkflow, that should be defined with the compiler context | + + + + + + + + +### WorkflowTemplate +Flyte Workflow Structure that encapsulates task, branch and subworkflow nodes to form a statically analyzable, +directed acyclic graph. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [Identifier](#flyteidl.core.Identifier) | | A globally unique identifier for the workflow. | +| metadata | [WorkflowMetadata](#flyteidl.core.WorkflowMetadata) | | Extra metadata about the workflow. | +| interface | [TypedInterface](#flyteidl.core.TypedInterface) | | Defines a strongly typed interface for the Workflow. This can include some optional parameters. | +| nodes | [Node](#flyteidl.core.Node) | repeated | A list of nodes. In addition, "globals" is a special reserved node id that can be used to consume workflow inputs. | +| outputs | [Binding](#flyteidl.core.Binding) | repeated | A list of output bindings that specify how to construct workflow outputs. Bindings can pull node outputs or specify literals. All workflow outputs specified in the interface field must be bound in order for the workflow to be validated. A workflow has an implicit dependency on all of its nodes to execute successfully in order to bind final outputs. Most of these outputs will be Binding's with a BindingData of type OutputReference. That is, your workflow can just have an output of some constant (`Output(5)`), but usually, the workflow will be pulling outputs from the output of a task. | +| failure_node | [Node](#flyteidl.core.Node) | | +optional A catch-all node. This node is executed whenever the execution engine determines the workflow has failed. The interface of this node must match the Workflow interface with an additional input named "error" of type pb.lyft.flyte.core.Error. | +| metadata_defaults | [WorkflowMetadataDefaults](#flyteidl.core.WorkflowMetadataDefaults) | | workflow defaults | + + + + + + + + + + +### WorkflowMetadata.OnFailurePolicy +Failure Handling Strategy + +| Name | Number | Description | +| ---- | ------ | ----------- | +| FAIL_IMMEDIATELY | 0 | FAIL_IMMEDIATELY instructs the system to fail as soon as a node fails in the workflow. It'll automatically abort all currently running nodes and clean up resources before finally marking the workflow executions as failed. | +| FAIL_AFTER_EXECUTABLE_NODES_COMPLETE | 1 | FAIL_AFTER_EXECUTABLE_NODES_COMPLETE instructs the system to make as much progress as it can. The system will not alter the dependencies of the execution graph so any node that depend on the failed node will not be run. Other nodes that will be executed to completion before cleaning up resources and marking the workflow execution as failed. | + + + + + + + + + + + +

Top

+ +## flyteidl/core/workflow_closure.proto + + + + + +### WorkflowClosure +Defines an enclosed package of workflow and tasks it references. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| workflow | [WorkflowTemplate](#flyteidl.core.WorkflowTemplate) | | required. Workflow template. | +| tasks | [TaskTemplate](#flyteidl.core.TaskTemplate) | repeated | optional. A collection of tasks referenced by the workflow. Only needed if the workflow references tasks. | + + + + + + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | float | float | Float | +| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/flyteidl/protos/flyteidl/core/title.rst b/flyteidl/protos/docs/core/index.rst similarity index 80% rename from flyteidl/protos/flyteidl/core/title.rst rename to flyteidl/protos/docs/core/index.rst index a08195c14a..2f427d1ee9 100644 --- a/flyteidl/protos/flyteidl/core/title.rst +++ b/flyteidl/protos/docs/core/index.rst @@ -5,4 +5,9 @@ These set of protocol buffers provides details of some of the core data structures like Workflows, Tasks, Nodes, Literals. These are the specification of the various entities in Flyte as well as the type system. +.. toctree:: + :maxdepth: 1 + :caption: core + :name: coretoc + core diff --git a/flyteidl/protos/docs/datacatalog/datacatalog.md b/flyteidl/protos/docs/datacatalog/datacatalog.md new file mode 100644 index 0000000000..0f024ae7fa --- /dev/null +++ b/flyteidl/protos/docs/datacatalog/datacatalog.md @@ -0,0 +1,746 @@ +# Protocol Documentation + + +## Table of Contents + +- [flyteidl/datacatalog/datacatalog.proto](#flyteidl/datacatalog/datacatalog.proto) + - [AddTagRequest](#datacatalog.AddTagRequest) + - [AddTagResponse](#datacatalog.AddTagResponse) + - [Artifact](#datacatalog.Artifact) + - [ArtifactData](#datacatalog.ArtifactData) + - [ArtifactPropertyFilter](#datacatalog.ArtifactPropertyFilter) + - [CreateArtifactRequest](#datacatalog.CreateArtifactRequest) + - [CreateArtifactResponse](#datacatalog.CreateArtifactResponse) + - [CreateDatasetRequest](#datacatalog.CreateDatasetRequest) + - [CreateDatasetResponse](#datacatalog.CreateDatasetResponse) + - [Dataset](#datacatalog.Dataset) + - [DatasetID](#datacatalog.DatasetID) + - [DatasetPropertyFilter](#datacatalog.DatasetPropertyFilter) + - [ExtendReservationRequest](#datacatalog.ExtendReservationRequest) + - [ExtendReservationResponse](#datacatalog.ExtendReservationResponse) + - [FilterExpression](#datacatalog.FilterExpression) + - [GetArtifactRequest](#datacatalog.GetArtifactRequest) + - [GetArtifactResponse](#datacatalog.GetArtifactResponse) + - [GetDatasetRequest](#datacatalog.GetDatasetRequest) + - [GetDatasetResponse](#datacatalog.GetDatasetResponse) + - [GetOrReserveArtifactRequest](#datacatalog.GetOrReserveArtifactRequest) + - [GetOrReserveArtifactResponse](#datacatalog.GetOrReserveArtifactResponse) + - [KeyValuePair](#datacatalog.KeyValuePair) + - [ListArtifactsRequest](#datacatalog.ListArtifactsRequest) + - [ListArtifactsResponse](#datacatalog.ListArtifactsResponse) + - [ListDatasetsRequest](#datacatalog.ListDatasetsRequest) + - [ListDatasetsResponse](#datacatalog.ListDatasetsResponse) + - [Metadata](#datacatalog.Metadata) + - [Metadata.KeyMapEntry](#datacatalog.Metadata.KeyMapEntry) + - [PaginationOptions](#datacatalog.PaginationOptions) + - [Partition](#datacatalog.Partition) + - [PartitionPropertyFilter](#datacatalog.PartitionPropertyFilter) + - [ReleaseReservationRequest](#datacatalog.ReleaseReservationRequest) + - [ReleaseReservationResponse](#datacatalog.ReleaseReservationResponse) + - [ReservationStatus](#datacatalog.ReservationStatus) + - [SinglePropertyFilter](#datacatalog.SinglePropertyFilter) + - [Tag](#datacatalog.Tag) + - [TagPropertyFilter](#datacatalog.TagPropertyFilter) + + - [PaginationOptions.SortKey](#datacatalog.PaginationOptions.SortKey) + - [PaginationOptions.SortOrder](#datacatalog.PaginationOptions.SortOrder) + - [ReservationStatus.State](#datacatalog.ReservationStatus.State) + - [SinglePropertyFilter.ComparisonOperator](#datacatalog.SinglePropertyFilter.ComparisonOperator) + + - [DataCatalog](#datacatalog.DataCatalog) + +- [Scalar Value Types](#scalar-value-types) + + + + +

Top

+ +## flyteidl/datacatalog/datacatalog.proto + + + + + +### AddTagRequest +Request message for tagging an Artifact. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| tag | [Tag](#datacatalog.Tag) | | | + + + + + + + + +### AddTagResponse +Response message for tagging an Artifact. + + + + + + + + +### Artifact +Artifact message. It is composed of several string fields. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | The unique ID of the artifact | +| dataset | [DatasetID](#datacatalog.DatasetID) | | The Dataset that the artifact belongs to | +| data | [ArtifactData](#datacatalog.ArtifactData) | repeated | A list of data that is associated with the artifact | +| metadata | [Metadata](#datacatalog.Metadata) | | Free-form metadata associated with the artifact | +| partitions | [Partition](#datacatalog.Partition) | repeated | | +| tags | [Tag](#datacatalog.Tag) | repeated | | +| created_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | creation timestamp of artifact, autogenerated by service | + + + + + + + + +### ArtifactData +ArtifactData that belongs to an artifact + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| value | [flyteidl.core.Literal](#flyteidl.core.Literal) | | | + + + + + + + + +### ArtifactPropertyFilter +Artifact properties we can filter by + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| artifact_id | [string](#string) | | | + + + + + + + + +### CreateArtifactRequest +Request message for creating an Artifact and its associated artifact Data. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| artifact | [Artifact](#datacatalog.Artifact) | | | + + + + + + + + +### CreateArtifactResponse +Response message for creating an Artifact. + + + + + + + + +### CreateDatasetRequest +Request message for creating a Dataset. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| dataset | [Dataset](#datacatalog.Dataset) | | | + + + + + + + + +### CreateDatasetResponse +Response message for creating a Dataset + + + + + + + + +### Dataset +Dataset message. It is uniquely identified by DatasetID. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [DatasetID](#datacatalog.DatasetID) | | | +| metadata | [Metadata](#datacatalog.Metadata) | | | +| partitionKeys | [string](#string) | repeated | | + + + + + + + + +### DatasetID +DatasetID message that is composed of several string fields. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| project | [string](#string) | | The name of the project | +| name | [string](#string) | | The name of the dataset | +| domain | [string](#string) | | The domain (eg. environment) | +| version | [string](#string) | | Version of the data schema | +| UUID | [string](#string) | | UUID for the dataset (if set the above fields are optional) | + + + + + + + + +### DatasetPropertyFilter +Dataset properties we can filter by + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| project | [string](#string) | | | +| name | [string](#string) | | | +| domain | [string](#string) | | | +| version | [string](#string) | | | + + + + + + + + +### ExtendReservationRequest +Request to extend reservation + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| dataset_id | [DatasetID](#datacatalog.DatasetID) | | | +| tag_name | [string](#string) | | | +| owner_id | [string](#string) | | | + + + + + + + + +### ExtendReservationResponse +Response to extend reservation + + + + + + + + +### FilterExpression +Filter expression that is composed of a combination of single filters + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| filters | [SinglePropertyFilter](#datacatalog.SinglePropertyFilter) | repeated | | + + + + + + + + +### GetArtifactRequest +Request message for retrieving an Artifact. Retrieve an artifact based on a query handle that +can be one of artifact_id or tag. The result returned will include the artifact data and metadata +associated with the artifact. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| dataset | [DatasetID](#datacatalog.DatasetID) | | | +| artifact_id | [string](#string) | | | +| tag_name | [string](#string) | | | + + + + + + + + +### GetArtifactResponse +Response message for retrieving an Artifact. The result returned will include the artifact data +and metadata associated with the artifact. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| artifact | [Artifact](#datacatalog.Artifact) | | | + + + + + + + + +### GetDatasetRequest +Request message for retrieving a Dataset. The Dataset is retrieved by it's unique identifier +which is a combination of several fields. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| dataset | [DatasetID](#datacatalog.DatasetID) | | | + + + + + + + + +### GetDatasetResponse +Response message for retrieving a Dataset. The response will include the metadata for the +Dataset. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| dataset | [Dataset](#datacatalog.Dataset) | | | + + + + + + + + +### GetOrReserveArtifactRequest +Get the Artifact or try to reserve a spot if the Artifact does not exist. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| dataset_id | [DatasetID](#datacatalog.DatasetID) | | | +| tag_name | [string](#string) | | | +| owner_id | [string](#string) | | | + + + + + + + + +### GetOrReserveArtifactResponse +Response to get artifact or reserve spot. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| artifact | [Artifact](#datacatalog.Artifact) | | | +| reservation_status | [ReservationStatus](#datacatalog.ReservationStatus) | | | + + + + + + + + +### KeyValuePair + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + + + + + + +### ListArtifactsRequest +List the artifacts that belong to the Dataset, optionally filtered using filtered expression. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| dataset | [DatasetID](#datacatalog.DatasetID) | | Use a datasetID for which you want to retrieve the artifacts | +| filter | [FilterExpression](#datacatalog.FilterExpression) | | Apply the filter expression to this query | +| pagination | [PaginationOptions](#datacatalog.PaginationOptions) | | Pagination options to get a page of artifacts | + + + + + + + + +### ListArtifactsResponse +Response to list artifacts + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| artifacts | [Artifact](#datacatalog.Artifact) | repeated | The list of artifacts | +| next_token | [string](#string) | | Token to use to request the next page, pass this into the next requests PaginationOptions | + + + + + + + + +### ListDatasetsRequest +List the datasets for the given query + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| filter | [FilterExpression](#datacatalog.FilterExpression) | | Apply the filter expression to this query | +| pagination | [PaginationOptions](#datacatalog.PaginationOptions) | | Pagination options to get a page of datasets | + + + + + + + + +### ListDatasetsResponse +List the datasets response with token for next pagination + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| datasets | [Dataset](#datacatalog.Dataset) | repeated | The list of datasets | +| next_token | [string](#string) | | Token to use to request the next page, pass this into the next requests PaginationOptions | + + + + + + + + +### Metadata +Metadata representation for artifacts and datasets + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key_map | [Metadata.KeyMapEntry](#datacatalog.Metadata.KeyMapEntry) | repeated | key map is a dictionary of key/val strings that represent metadata | + + + + + + + + +### Metadata.KeyMapEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + + + + + + +### PaginationOptions +Pagination options for making list requests + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| limit | [uint32](#uint32) | | the max number of results to return | +| token | [string](#string) | | the token to pass to fetch the next page | +| sortKey | [PaginationOptions.SortKey](#datacatalog.PaginationOptions.SortKey) | | the property that we want to sort the results by | +| sortOrder | [PaginationOptions.SortOrder](#datacatalog.PaginationOptions.SortOrder) | | the sort order of the results | + + + + + + + + +### Partition +An artifact could have multiple partitions and each partition can have an arbitrary string key/value pair + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + + + + + + +### PartitionPropertyFilter +Partition properties we can filter by + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key_val | [KeyValuePair](#datacatalog.KeyValuePair) | | | + + + + + + + + +### ReleaseReservationRequest +Request to release reservation + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| dataset_id | [DatasetID](#datacatalog.DatasetID) | | | +| tag_name | [string](#string) | | | +| owner_id | [string](#string) | | | + + + + + + + + +### ReleaseReservationResponse +Response to release reservation + + + + + + + + +### ReservationStatus +Whether we successfully reserve a spot. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| state | [ReservationStatus.State](#datacatalog.ReservationStatus.State) | | | +| metadata | [Metadata](#datacatalog.Metadata) | | | +| owner_id | [string](#string) | | | + + + + + + + + +### SinglePropertyFilter +A single property to filter on. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| tag_filter | [TagPropertyFilter](#datacatalog.TagPropertyFilter) | | | +| partition_filter | [PartitionPropertyFilter](#datacatalog.PartitionPropertyFilter) | | | +| artifact_filter | [ArtifactPropertyFilter](#datacatalog.ArtifactPropertyFilter) | | | +| dataset_filter | [DatasetPropertyFilter](#datacatalog.DatasetPropertyFilter) | | | +| operator | [SinglePropertyFilter.ComparisonOperator](#datacatalog.SinglePropertyFilter.ComparisonOperator) | | field 10 in case we add more entities to query | + + + + + + + + +### Tag +Tag message that is unique to a Dataset. It is associated to a single artifact and +can be retrieved by name later. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | Name of tag | +| artifact_id | [string](#string) | | The tagged artifact | +| dataset | [DatasetID](#datacatalog.DatasetID) | | The Dataset that this tag belongs to | + + + + + + + + +### TagPropertyFilter +Tag properties we can filter by + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| tag_name | [string](#string) | | | + + + + + + + + + + +### PaginationOptions.SortKey + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| CREATION_TIME | 0 | | + + + + + +### PaginationOptions.SortOrder + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| DESCENDING | 0 | | +| ASCENDING | 1 | | + + + + + +### ReservationStatus.State + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| ACQUIRED | 0 | Acquired the reservation successfully. | +| ALREADY_IN_PROGRESS | 1 | Indicates an existing active reservation exist for a different owner_id. | + + + + + +### SinglePropertyFilter.ComparisonOperator +as use-cases come up we can add more operators, ex: gte, like, not eq etc. + +| Name | Number | Description | +| ---- | ------ | ----------- | +| EQUALS | 0 | | + + + + + + + + + +### DataCatalog +Data Catalog service definition +Data Catalog is a service for indexing parameterized, strongly-typed data artifacts across revisions. +Artifacts are associated with a Dataset, and can be tagged for retrieval. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| CreateDataset | [CreateDatasetRequest](#datacatalog.CreateDatasetRequest) | [CreateDatasetResponse](#datacatalog.CreateDatasetResponse) | Create a new Dataset. Datasets are unique based on the DatasetID. Datasets are logical groupings of artifacts. Each dataset can have one or more artifacts | +| GetDataset | [GetDatasetRequest](#datacatalog.GetDatasetRequest) | [GetDatasetResponse](#datacatalog.GetDatasetResponse) | Get a Dataset by the DatasetID. This returns the Dataset with the associated metadata. | +| CreateArtifact | [CreateArtifactRequest](#datacatalog.CreateArtifactRequest) | [CreateArtifactResponse](#datacatalog.CreateArtifactResponse) | Create an artifact and the artifact data associated with it. An artifact can be a hive partition or arbitrary files or data values | +| GetArtifact | [GetArtifactRequest](#datacatalog.GetArtifactRequest) | [GetArtifactResponse](#datacatalog.GetArtifactResponse) | Retrieve an artifact by an identifying handle. This returns an artifact along with the artifact data. | +| AddTag | [AddTagRequest](#datacatalog.AddTagRequest) | [AddTagResponse](#datacatalog.AddTagResponse) | Associate a tag with an artifact. Tags are unique within a Dataset. | +| ListArtifacts | [ListArtifactsRequest](#datacatalog.ListArtifactsRequest) | [ListArtifactsResponse](#datacatalog.ListArtifactsResponse) | Return a paginated list of artifacts | +| ListDatasets | [ListDatasetsRequest](#datacatalog.ListDatasetsRequest) | [ListDatasetsResponse](#datacatalog.ListDatasetsResponse) | Return a paginated list of datasets | +| GetOrReserveArtifact | [GetOrReserveArtifactRequest](#datacatalog.GetOrReserveArtifactRequest) | [GetOrReserveArtifactResponse](#datacatalog.GetOrReserveArtifactResponse) | Get an artifact and the corresponding data. If the artifact does not exist, try to reserve a spot for populating the artifact. + +Once you preserve a spot, you should call ExtendReservation API periodically to extend the reservation. Otherwise, the reservation can expire and other tasks may take the spot. + +If the same owner_id calls this API for the same dataset and it has an active reservation and the artifacts have not been written yet by a different owner, the API will respond with an Acquired Reservation Status (providing idempotency). + +Note: We may have multiple concurrent tasks with the same signature and the same input that try to populate the same artifact at the same time. Thus with reservation, only one task can run at a time, until the reservation expires. + +Note: If task A does not extend the reservation in time and the reservation expires, another task B may take over the reservation, resulting in two tasks A and B running in parallel. So a third task C may get the Artifact from A or B, whichever writes last. | +| ExtendReservation | [ExtendReservationRequest](#datacatalog.ExtendReservationRequest) | [ExtendReservationResponse](#datacatalog.ExtendReservationResponse) | Extend the reservation to keep it from expiring. If the reservation expires, other tasks can take over the reservation by calling GetOrReserveArtifact. | +| ReleaseReservation | [ReleaseReservationRequest](#datacatalog.ReleaseReservationRequest) | [ReleaseReservationResponse](#datacatalog.ReleaseReservationResponse) | Release the reservation when the task holding the spot fails so that the other tasks can grab the spot. | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | float | float | Float | +| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/flyteidl/gen/pb-protodoc/flyteidl/datacatalog/index.rst b/flyteidl/protos/docs/datacatalog/index.rst similarity index 79% rename from flyteidl/gen/pb-protodoc/flyteidl/datacatalog/index.rst rename to flyteidl/protos/docs/datacatalog/index.rst index 1e3c4382ba..aa9f8ff7cb 100644 --- a/flyteidl/gen/pb-protodoc/flyteidl/datacatalog/index.rst +++ b/flyteidl/protos/docs/datacatalog/index.rst @@ -1,15 +1,14 @@ Flyte Data Catalog Service -~~~~~~~~~~~~~~~~~~~~~~~~~~ +================================= These protos provide the interface definition for the Data Catalog Service. Data Catalog is a service for indexing parameterized, strongly-typed data artifacts across revisions. It is used in the Flyte ecosystem to catalog artifacts generated by task executions. Outputs generated by a task can be stored as artifact data and tagged by the user so that it can be retrieved later by that tag. - .. toctree:: - :maxdepth: 1 - :caption: datacatalog - :name: datacatalogtoc + :maxdepth: 1 + :caption: datacatalog + :name: datacatalogtoc - datacatalog.proto + datacatalog diff --git a/flyteidl/protos/docs/event/event.md b/flyteidl/protos/docs/event/event.md new file mode 100644 index 0000000000..5020e66f7d --- /dev/null +++ b/flyteidl/protos/docs/event/event.md @@ -0,0 +1,281 @@ +# Protocol Documentation + + +## Table of Contents + +- [flyteidl/event/event.proto](#flyteidl/event/event.proto) + - [DynamicWorkflowNodeMetadata](#flyteidl.event.DynamicWorkflowNodeMetadata) + - [ExternalResourceInfo](#flyteidl.event.ExternalResourceInfo) + - [NodeExecutionEvent](#flyteidl.event.NodeExecutionEvent) + - [ParentNodeExecutionMetadata](#flyteidl.event.ParentNodeExecutionMetadata) + - [ParentTaskExecutionMetadata](#flyteidl.event.ParentTaskExecutionMetadata) + - [ResourcePoolInfo](#flyteidl.event.ResourcePoolInfo) + - [TaskExecutionEvent](#flyteidl.event.TaskExecutionEvent) + - [TaskExecutionMetadata](#flyteidl.event.TaskExecutionMetadata) + - [TaskNodeMetadata](#flyteidl.event.TaskNodeMetadata) + - [WorkflowExecutionEvent](#flyteidl.event.WorkflowExecutionEvent) + - [WorkflowNodeMetadata](#flyteidl.event.WorkflowNodeMetadata) + + - [TaskExecutionMetadata.InstanceClass](#flyteidl.event.TaskExecutionMetadata.InstanceClass) + +- [Scalar Value Types](#scalar-value-types) + + + + +

Top

+ +## flyteidl/event/event.proto + + + + + +### DynamicWorkflowNodeMetadata +For dynamic workflow nodes we send information about the dynamic workflow definition that gets generated. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.Identifier](#flyteidl.core.Identifier) | | id represents the unique identifier of the workflow. | +| compiled_workflow | [flyteidl.core.CompiledWorkflowClosure](#flyteidl.core.CompiledWorkflowClosure) | | Represents the compiled representation of the embedded dynamic workflow. | + + + + + + + + +### ExternalResourceInfo +This message contains metadata about external resources produced or used by a specific task execution. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| external_id | [string](#string) | | Identifier for an external resource created by this task execution, for example Qubole query ID or presto query ids. | + + + + + + + + +### NodeExecutionEvent + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.NodeExecutionIdentifier](#flyteidl.core.NodeExecutionIdentifier) | | Unique identifier for this node execution | +| producer_id | [string](#string) | | the id of the originator (Propeller) of the event | +| phase | [flyteidl.core.NodeExecution.Phase](#flyteidl.core.NodeExecution.Phase) | | | +| occurred_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | This timestamp represents when the original event occurred, it is generated by the executor of the node. | +| input_uri | [string](#string) | | | +| output_uri | [string](#string) | | URL to the output of the execution, it encodes all the information including Cloud source provider. ie., s3://... | +| error | [flyteidl.core.ExecutionError](#flyteidl.core.ExecutionError) | | Error information for the execution | +| workflow_node_metadata | [WorkflowNodeMetadata](#flyteidl.event.WorkflowNodeMetadata) | | | +| task_node_metadata | [TaskNodeMetadata](#flyteidl.event.TaskNodeMetadata) | | | +| parent_task_metadata | [ParentTaskExecutionMetadata](#flyteidl.event.ParentTaskExecutionMetadata) | | [To be deprecated] Specifies which task (if any) launched this node. | +| parent_node_metadata | [ParentNodeExecutionMetadata](#flyteidl.event.ParentNodeExecutionMetadata) | | Specifies the parent node of the current node execution. Node executions at level zero will not have a parent node. | +| retry_group | [string](#string) | | Retry group to indicate grouping of nodes by retries | +| spec_node_id | [string](#string) | | Identifier of the node in the original workflow/graph This maps to value of WorkflowTemplate.nodes[X].id | +| node_name | [string](#string) | | Friendly readable name for the node | + + + + + + + + +### ParentNodeExecutionMetadata + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| node_id | [string](#string) | | Unique identifier of the parent node id within the execution This is value of core.NodeExecutionIdentifier.node_id of the parent node | + + + + + + + + +### ParentTaskExecutionMetadata + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [flyteidl.core.TaskExecutionIdentifier](#flyteidl.core.TaskExecutionIdentifier) | | | + + + + + + + + +### ResourcePoolInfo +This message holds task execution metadata specific to resource allocation used to manage concurrent +executions for a project namespace. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| allocation_token | [string](#string) | | Unique resource ID used to identify this execution when allocating a token. | +| namespace | [string](#string) | | Namespace under which this task execution requested an allocation token. | + + + + + + + + +### TaskExecutionEvent +Plugin specific execution event information. For tasks like Python, Hive, Spark, DynamicJob. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| task_id | [flyteidl.core.Identifier](#flyteidl.core.Identifier) | | ID of the task. In combination with the retryAttempt this will indicate the task execution uniquely for a given parent node execution. | +| parent_node_execution_id | [flyteidl.core.NodeExecutionIdentifier](#flyteidl.core.NodeExecutionIdentifier) | | A task execution is always kicked off by a node execution, the event consumer will use the parent_id to relate the task to it's parent node execution | +| retry_attempt | [uint32](#uint32) | | retry attempt number for this task, ie., 2 for the second attempt | +| phase | [flyteidl.core.TaskExecution.Phase](#flyteidl.core.TaskExecution.Phase) | | Phase associated with the event | +| producer_id | [string](#string) | | id of the process that sent this event, mainly for trace debugging | +| logs | [flyteidl.core.TaskLog](#flyteidl.core.TaskLog) | repeated | log information for the task execution | +| occurred_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | This timestamp represents when the original event occurred, it is generated by the executor of the task. | +| input_uri | [string](#string) | | URI of the input file, it encodes all the information including Cloud source provider. ie., s3://... | +| output_uri | [string](#string) | | URI to the output of the execution, it will be in a format that encodes all the information including Cloud source provider. ie., s3://... | +| error | [flyteidl.core.ExecutionError](#flyteidl.core.ExecutionError) | | Error information for the execution | +| custom_info | [google.protobuf.Struct](#google.protobuf.Struct) | | Custom data that the task plugin sends back. This is extensible to allow various plugins in the system. | +| phase_version | [uint32](#uint32) | | Some phases, like RUNNING, can send multiple events with changed metadata (new logs, additional custom_info, etc) that should be recorded regardless of the lack of phase change. The version field should be incremented when metadata changes across the duration of an individual phase. | +| reason | [string](#string) | | An optional explanation for the phase transition. | +| task_type | [string](#string) | | A predefined yet extensible Task type identifier. If the task definition is already registered in flyte admin this type will be identical, but not all task executions necessarily use pre-registered definitions and this type is useful to render the task in the UI, filter task executions, etc. | +| metadata | [TaskExecutionMetadata](#flyteidl.event.TaskExecutionMetadata) | | Metadata around how a task was executed. | + + + + + + + + +### TaskExecutionMetadata +Holds metadata around how a task was executed. +As a task transitions across event phases during execution some attributes, such its generated name, generated external resources, +and more may grow in size but not change necessarily based on the phase transition that sparked the event update. +Metadata is a container for these attributes across the task execution lifecycle. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| generated_name | [string](#string) | | Unique, generated name for this task execution used by the backend. | +| external_resources | [ExternalResourceInfo](#flyteidl.event.ExternalResourceInfo) | repeated | Additional data on external resources on other back-ends or platforms (e.g. Hive, Qubole, etc) launched by this task execution. | +| resource_pool_info | [ResourcePoolInfo](#flyteidl.event.ResourcePoolInfo) | repeated | Includes additional data on concurrent resource management used during execution.. This is a repeated field because a plugin can request multiple resource allocations during execution. | +| plugin_identifier | [string](#string) | | The identifier of the plugin used to execute this task. | +| instance_class | [TaskExecutionMetadata.InstanceClass](#flyteidl.event.TaskExecutionMetadata.InstanceClass) | | | + + + + + + + + +### TaskNodeMetadata + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cache_status | [flyteidl.core.CatalogCacheStatus](#flyteidl.core.CatalogCacheStatus) | | Captures the status of caching for this execution. | +| catalog_key | [flyteidl.core.CatalogMetadata](#flyteidl.core.CatalogMetadata) | | This structure carries the catalog artifact information | +| dynamic_workflow | [DynamicWorkflowNodeMetadata](#flyteidl.event.DynamicWorkflowNodeMetadata) | | In the case this task launched a dynamic workflow we capture its structure here. | + + + + + + + + +### WorkflowExecutionEvent + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| execution_id | [flyteidl.core.WorkflowExecutionIdentifier](#flyteidl.core.WorkflowExecutionIdentifier) | | Workflow execution id | +| producer_id | [string](#string) | | the id of the originator (Propeller) of the event | +| phase | [flyteidl.core.WorkflowExecution.Phase](#flyteidl.core.WorkflowExecution.Phase) | | | +| occurred_at | [google.protobuf.Timestamp](#google.protobuf.Timestamp) | | This timestamp represents when the original event occurred, it is generated by the executor of the workflow. | +| output_uri | [string](#string) | | URL to the output of the execution, it encodes all the information including Cloud source provider. ie., s3://... | +| error | [flyteidl.core.ExecutionError](#flyteidl.core.ExecutionError) | | Error information for the execution | + + + + + + + + +### WorkflowNodeMetadata +For Workflow Nodes we need to send information about the workflow that's launched + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| execution_id | [flyteidl.core.WorkflowExecutionIdentifier](#flyteidl.core.WorkflowExecutionIdentifier) | | | + + + + + + + + + + +### TaskExecutionMetadata.InstanceClass +Includes the broad cateogry of machine used for this specific task execution. + +| Name | Number | Description | +| ---- | ------ | ----------- | +| DEFAULT | 0 | The default instance class configured for the flyte application platform. | +| INTERRUPTIBLE | 1 | The instance class configured for interruptible tasks. | + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | float | float | Float | +| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/flyteidl/gen/pb-protodoc/flyteidl/event/index.rst b/flyteidl/protos/docs/event/index.rst similarity index 96% rename from flyteidl/gen/pb-protodoc/flyteidl/event/index.rst rename to flyteidl/protos/docs/event/index.rst index 2ca8562ae4..e7ba039fca 100644 --- a/flyteidl/gen/pb-protodoc/flyteidl/event/index.rst +++ b/flyteidl/protos/docs/event/index.rst @@ -1,3 +1,4 @@ + ############################################## Flyte Internal and External Eventing interface ############################################## @@ -9,7 +10,7 @@ Flyte Internal Eventing ======================== This is the interface used by the dataplane (execution engine) to communicate -workflow and task progress back to the **control plane** admin service. +workflow and task progress back to the **control plane** admin service. Flyte External Eventing - Event Egress ======================================= @@ -17,11 +18,9 @@ Flyte External Eventing - Event Egress This refers to the interface for all the event messages exiting from the Flyte **control plane** and delivered on the configured pubsub channel. - - .. toctree:: :maxdepth: 1 :caption: event :name: eventtoc - event.proto + event diff --git a/flyteidl/protos/flyteidl/plugins/title.rst b/flyteidl/protos/docs/plugins/index.rst similarity index 66% rename from flyteidl/protos/flyteidl/plugins/title.rst rename to flyteidl/protos/docs/plugins/index.rst index 753ec7dc6d..f10ce41610 100644 --- a/flyteidl/protos/flyteidl/plugins/title.rst +++ b/flyteidl/protos/docs/plugins/index.rst @@ -4,3 +4,9 @@ Flyte Task Plugins These protocol buffer specifications provide information about the various Task Plugins available in the Flyte system. +.. toctree:: + :maxdepth: 1 + :caption: plugins + :name: pluginstoc + + plugins diff --git a/flyteidl/protos/docs/plugins/plugins.md b/flyteidl/protos/docs/plugins/plugins.md new file mode 100644 index 0000000000..dfa4b543ff --- /dev/null +++ b/flyteidl/protos/docs/plugins/plugins.md @@ -0,0 +1,420 @@ +# Protocol Documentation + + +## Table of Contents + +- [flyteidl/plugins/array_job.proto](#flyteidl/plugins/array_job.proto) + - [ArrayJob](#flyteidl.plugins.ArrayJob) + +- [flyteidl/plugins/presto.proto](#flyteidl/plugins/presto.proto) + - [PrestoQuery](#flyteidl.plugins.PrestoQuery) + +- [flyteidl/plugins/pytorch.proto](#flyteidl/plugins/pytorch.proto) + - [DistributedPyTorchTrainingTask](#flyteidl.plugins.DistributedPyTorchTrainingTask) + +- [flyteidl/plugins/qubole.proto](#flyteidl/plugins/qubole.proto) + - [HiveQuery](#flyteidl.plugins.HiveQuery) + - [HiveQueryCollection](#flyteidl.plugins.HiveQueryCollection) + - [QuboleHiveJob](#flyteidl.plugins.QuboleHiveJob) + +- [flyteidl/plugins/sidecar.proto](#flyteidl/plugins/sidecar.proto) + - [SidecarJob](#flyteidl.plugins.SidecarJob) + +- [flyteidl/plugins/spark.proto](#flyteidl/plugins/spark.proto) + - [SparkApplication](#flyteidl.plugins.SparkApplication) + - [SparkJob](#flyteidl.plugins.SparkJob) + - [SparkJob.HadoopConfEntry](#flyteidl.plugins.SparkJob.HadoopConfEntry) + - [SparkJob.SparkConfEntry](#flyteidl.plugins.SparkJob.SparkConfEntry) + + - [SparkApplication.Type](#flyteidl.plugins.SparkApplication.Type) + +- [flyteidl/plugins/tensorflow.proto](#flyteidl/plugins/tensorflow.proto) + - [DistributedTensorflowTrainingTask](#flyteidl.plugins.DistributedTensorflowTrainingTask) + +- [flyteidl/plugins/waitable.proto](#flyteidl/plugins/waitable.proto) + - [Waitable](#flyteidl.plugins.Waitable) + +- [Scalar Value Types](#scalar-value-types) + + + + +

Top

+ +## flyteidl/plugins/array_job.proto + + + + + +### ArrayJob +Describes a job that can process independent pieces of data concurrently. Multiple copies of the runnable component +will be executed concurrently. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| parallelism | [int64](#int64) | | Defines the minimum number of instances to bring up concurrently at any given point. Note that this is an optimistic restriction and that, due to network partitioning or other failures, the actual number of currently running instances might be more. This has to be a positive number if assigned. Default value is size. | +| size | [int64](#int64) | | Defines the number of instances to launch at most. This number should match the size of the input if the job requires processing of all input data. This has to be a positive number. In the case this is not defined, the back-end will determine the size at run-time by reading the inputs. | +| min_successes | [int64](#int64) | | An absolute number of the minimum number of successful completions of subtasks. As soon as this criteria is met, the array job will be marked as successful and outputs will be computed. This has to be a non-negative number if assigned. Default value is size (if specified). | +| min_success_ratio | [float](#float) | | If the array job size is not known beforehand, the min_success_ratio can instead be used to determine when an array job can be marked successful. | + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/plugins/presto.proto + + + + + +### PrestoQuery +This message works with the 'presto' task type in the SDK and is the object that will be in the 'custom' field +of a Presto task's TaskTemplate + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| routing_group | [string](#string) | | | +| catalog | [string](#string) | | | +| schema | [string](#string) | | | +| statement | [string](#string) | | | + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/plugins/pytorch.proto + + + + + +### DistributedPyTorchTrainingTask +Custom proto for plugin that enables distributed training using https://github.com/kubeflow/pytorch-operator + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| workers | [int32](#int32) | | number of worker replicas spawned in the cluster for this job | + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/plugins/qubole.proto + + + + + +### HiveQuery +Defines a query to execute on a hive cluster. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| query | [string](#string) | | | +| timeout_sec | [uint32](#uint32) | | | +| retryCount | [uint32](#uint32) | | | + + + + + + + + +### HiveQueryCollection +Defines a collection of hive queries. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| queries | [HiveQuery](#flyteidl.plugins.HiveQuery) | repeated | | + + + + + + + + +### QuboleHiveJob +This message works with the 'hive' task type in the SDK and is the object that will be in the 'custom' field +of a hive task's TaskTemplate + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| cluster_label | [string](#string) | | | +| query_collection | [HiveQueryCollection](#flyteidl.plugins.HiveQueryCollection) | | **Deprecated.** | +| tags | [string](#string) | repeated | | +| query | [HiveQuery](#flyteidl.plugins.HiveQuery) | | | + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/plugins/sidecar.proto + + + + + +### SidecarJob +A sidecar job brings up the desired pod_spec. +The plugin executor is responsible for keeping the pod alive until the primary container terminates +or the task itself times out. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| pod_spec | [k8s.io.api.core.v1.PodSpec](#k8s.io.api.core.v1.PodSpec) | | | +| primary_container_name | [string](#string) | | | + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/plugins/spark.proto + + + + + +### SparkApplication + + + + + + + + + +### SparkJob +Custom Proto for Spark Plugin. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| applicationType | [SparkApplication.Type](#flyteidl.plugins.SparkApplication.Type) | | | +| mainApplicationFile | [string](#string) | | | +| mainClass | [string](#string) | | | +| sparkConf | [SparkJob.SparkConfEntry](#flyteidl.plugins.SparkJob.SparkConfEntry) | repeated | | +| hadoopConf | [SparkJob.HadoopConfEntry](#flyteidl.plugins.SparkJob.HadoopConfEntry) | repeated | | +| executorPath | [string](#string) | | Executor path for Python jobs. | + + + + + + + + +### SparkJob.HadoopConfEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + + + + + + +### SparkJob.SparkConfEntry + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| key | [string](#string) | | | +| value | [string](#string) | | | + + + + + + + + + + +### SparkApplication.Type + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| PYTHON | 0 | | +| JAVA | 1 | | +| SCALA | 2 | | +| R | 3 | | + + + + + + + + + + + +

Top

+ +## flyteidl/plugins/tensorflow.proto + + + + + +### DistributedTensorflowTrainingTask +Custom proto for plugin that enables distributed training using https://github.com/kubeflow/tf-operator + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| workers | [int32](#int32) | | number of worker, ps, chief replicas spawned in the cluster for this job | +| ps_replicas | [int32](#int32) | | PS -> Parameter server | +| chief_replicas | [int32](#int32) | | | + + + + + + + + + + + + + + + + +

Top

+ +## flyteidl/plugins/waitable.proto + + + + + +### Waitable +Represents an Execution that was launched and could be waited on. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| wf_exec_id | [flyteidl.core.WorkflowExecutionIdentifier](#flyteidl.core.WorkflowExecutionIdentifier) | | | +| phase | [flyteidl.core.WorkflowExecution.Phase](#flyteidl.core.WorkflowExecution.Phase) | | | +| workflow_id | [string](#string) | | | + + + + + + + + + + + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | float | float | Float | +| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/flyteidl/protos/docs/service/index.rst b/flyteidl/protos/docs/service/index.rst new file mode 100644 index 0000000000..d2d7a76442 --- /dev/null +++ b/flyteidl/protos/docs/service/index.rst @@ -0,0 +1,11 @@ +REST and gRPC interface for the Flyte Admin Service +=================================================== + +This section provides all endpoint defintions that are implemented by the Admin service. + +.. toctree:: + :maxdepth: 1 + :caption: service + :name: servicetoc + + service diff --git a/flyteidl/protos/docs/service/service.md b/flyteidl/protos/docs/service/service.md new file mode 100644 index 0000000000..b47214a532 --- /dev/null +++ b/flyteidl/protos/docs/service/service.md @@ -0,0 +1,265 @@ +# Protocol Documentation + + +## Table of Contents + +- [flyteidl/service/admin.proto](#flyteidl/service/admin.proto) + - [AdminService](#flyteidl.service.AdminService) + +- [flyteidl/service/auth.proto](#flyteidl/service/auth.proto) + - [OAuth2MetadataRequest](#flyteidl.service.OAuth2MetadataRequest) + - [OAuth2MetadataResponse](#flyteidl.service.OAuth2MetadataResponse) + - [PublicClientAuthConfigRequest](#flyteidl.service.PublicClientAuthConfigRequest) + - [PublicClientAuthConfigResponse](#flyteidl.service.PublicClientAuthConfigResponse) + + - [AuthMetadataService](#flyteidl.service.AuthMetadataService) + +- [flyteidl/service/identity.proto](#flyteidl/service/identity.proto) + - [UserInfoRequest](#flyteidl.service.UserInfoRequest) + - [UserInfoResponse](#flyteidl.service.UserInfoResponse) + + - [IdentityService](#flyteidl.service.IdentityService) + +- [Scalar Value Types](#scalar-value-types) + + + + +

Top

+ +## flyteidl/service/admin.proto + + + + + + + + + + + +### AdminService +The following defines an RPC service that is also served over HTTP via grpc-gateway. +Standard response codes for both are defined here: https://github.com/grpc-ecosystem/grpc-gateway/blob/master/runtime/errors.go + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| CreateTask | [.flyteidl.admin.TaskCreateRequest](#flyteidl.admin.TaskCreateRequest) | [.flyteidl.admin.TaskCreateResponse](#flyteidl.admin.TaskCreateResponse) | | +| GetTask | [.flyteidl.admin.ObjectGetRequest](#flyteidl.admin.ObjectGetRequest) | [.flyteidl.admin.Task](#flyteidl.admin.Task) | | +| ListTaskIds | [.flyteidl.admin.NamedEntityIdentifierListRequest](#flyteidl.admin.NamedEntityIdentifierListRequest) | [.flyteidl.admin.NamedEntityIdentifierList](#flyteidl.admin.NamedEntityIdentifierList) | | +| ListTasks | [.flyteidl.admin.ResourceListRequest](#flyteidl.admin.ResourceListRequest) | [.flyteidl.admin.TaskList](#flyteidl.admin.TaskList) | | +| CreateWorkflow | [.flyteidl.admin.WorkflowCreateRequest](#flyteidl.admin.WorkflowCreateRequest) | [.flyteidl.admin.WorkflowCreateResponse](#flyteidl.admin.WorkflowCreateResponse) | | +| GetWorkflow | [.flyteidl.admin.ObjectGetRequest](#flyteidl.admin.ObjectGetRequest) | [.flyteidl.admin.Workflow](#flyteidl.admin.Workflow) | | +| ListWorkflowIds | [.flyteidl.admin.NamedEntityIdentifierListRequest](#flyteidl.admin.NamedEntityIdentifierListRequest) | [.flyteidl.admin.NamedEntityIdentifierList](#flyteidl.admin.NamedEntityIdentifierList) | | +| ListWorkflows | [.flyteidl.admin.ResourceListRequest](#flyteidl.admin.ResourceListRequest) | [.flyteidl.admin.WorkflowList](#flyteidl.admin.WorkflowList) | | +| CreateLaunchPlan | [.flyteidl.admin.LaunchPlanCreateRequest](#flyteidl.admin.LaunchPlanCreateRequest) | [.flyteidl.admin.LaunchPlanCreateResponse](#flyteidl.admin.LaunchPlanCreateResponse) | | +| GetLaunchPlan | [.flyteidl.admin.ObjectGetRequest](#flyteidl.admin.ObjectGetRequest) | [.flyteidl.admin.LaunchPlan](#flyteidl.admin.LaunchPlan) | | +| GetActiveLaunchPlan | [.flyteidl.admin.ActiveLaunchPlanRequest](#flyteidl.admin.ActiveLaunchPlanRequest) | [.flyteidl.admin.LaunchPlan](#flyteidl.admin.LaunchPlan) | | +| ListActiveLaunchPlans | [.flyteidl.admin.ActiveLaunchPlanListRequest](#flyteidl.admin.ActiveLaunchPlanListRequest) | [.flyteidl.admin.LaunchPlanList](#flyteidl.admin.LaunchPlanList) | | +| ListLaunchPlanIds | [.flyteidl.admin.NamedEntityIdentifierListRequest](#flyteidl.admin.NamedEntityIdentifierListRequest) | [.flyteidl.admin.NamedEntityIdentifierList](#flyteidl.admin.NamedEntityIdentifierList) | | +| ListLaunchPlans | [.flyteidl.admin.ResourceListRequest](#flyteidl.admin.ResourceListRequest) | [.flyteidl.admin.LaunchPlanList](#flyteidl.admin.LaunchPlanList) | | +| UpdateLaunchPlan | [.flyteidl.admin.LaunchPlanUpdateRequest](#flyteidl.admin.LaunchPlanUpdateRequest) | [.flyteidl.admin.LaunchPlanUpdateResponse](#flyteidl.admin.LaunchPlanUpdateResponse) | | +| CreateExecution | [.flyteidl.admin.ExecutionCreateRequest](#flyteidl.admin.ExecutionCreateRequest) | [.flyteidl.admin.ExecutionCreateResponse](#flyteidl.admin.ExecutionCreateResponse) | | +| RelaunchExecution | [.flyteidl.admin.ExecutionRelaunchRequest](#flyteidl.admin.ExecutionRelaunchRequest) | [.flyteidl.admin.ExecutionCreateResponse](#flyteidl.admin.ExecutionCreateResponse) | | +| GetExecution | [.flyteidl.admin.WorkflowExecutionGetRequest](#flyteidl.admin.WorkflowExecutionGetRequest) | [.flyteidl.admin.Execution](#flyteidl.admin.Execution) | | +| GetExecutionData | [.flyteidl.admin.WorkflowExecutionGetDataRequest](#flyteidl.admin.WorkflowExecutionGetDataRequest) | [.flyteidl.admin.WorkflowExecutionGetDataResponse](#flyteidl.admin.WorkflowExecutionGetDataResponse) | | +| ListExecutions | [.flyteidl.admin.ResourceListRequest](#flyteidl.admin.ResourceListRequest) | [.flyteidl.admin.ExecutionList](#flyteidl.admin.ExecutionList) | | +| TerminateExecution | [.flyteidl.admin.ExecutionTerminateRequest](#flyteidl.admin.ExecutionTerminateRequest) | [.flyteidl.admin.ExecutionTerminateResponse](#flyteidl.admin.ExecutionTerminateResponse) | | +| GetNodeExecution | [.flyteidl.admin.NodeExecutionGetRequest](#flyteidl.admin.NodeExecutionGetRequest) | [.flyteidl.admin.NodeExecution](#flyteidl.admin.NodeExecution) | | +| ListNodeExecutions | [.flyteidl.admin.NodeExecutionListRequest](#flyteidl.admin.NodeExecutionListRequest) | [.flyteidl.admin.NodeExecutionList](#flyteidl.admin.NodeExecutionList) | | +| ListNodeExecutionsForTask | [.flyteidl.admin.NodeExecutionForTaskListRequest](#flyteidl.admin.NodeExecutionForTaskListRequest) | [.flyteidl.admin.NodeExecutionList](#flyteidl.admin.NodeExecutionList) | | +| GetNodeExecutionData | [.flyteidl.admin.NodeExecutionGetDataRequest](#flyteidl.admin.NodeExecutionGetDataRequest) | [.flyteidl.admin.NodeExecutionGetDataResponse](#flyteidl.admin.NodeExecutionGetDataResponse) | | +| RegisterProject | [.flyteidl.admin.ProjectRegisterRequest](#flyteidl.admin.ProjectRegisterRequest) | [.flyteidl.admin.ProjectRegisterResponse](#flyteidl.admin.ProjectRegisterResponse) | | +| UpdateProject | [.flyteidl.admin.Project](#flyteidl.admin.Project) | [.flyteidl.admin.ProjectUpdateResponse](#flyteidl.admin.ProjectUpdateResponse) | flyteidl.admin.Project should be passed but the domains property should be empty; it will be ignored in the handler as domains cannot be updated via this API. | +| ListProjects | [.flyteidl.admin.ProjectListRequest](#flyteidl.admin.ProjectListRequest) | [.flyteidl.admin.Projects](#flyteidl.admin.Projects) | | +| CreateWorkflowEvent | [.flyteidl.admin.WorkflowExecutionEventRequest](#flyteidl.admin.WorkflowExecutionEventRequest) | [.flyteidl.admin.WorkflowExecutionEventResponse](#flyteidl.admin.WorkflowExecutionEventResponse) | | +| CreateNodeEvent | [.flyteidl.admin.NodeExecutionEventRequest](#flyteidl.admin.NodeExecutionEventRequest) | [.flyteidl.admin.NodeExecutionEventResponse](#flyteidl.admin.NodeExecutionEventResponse) | | +| CreateTaskEvent | [.flyteidl.admin.TaskExecutionEventRequest](#flyteidl.admin.TaskExecutionEventRequest) | [.flyteidl.admin.TaskExecutionEventResponse](#flyteidl.admin.TaskExecutionEventResponse) | | +| GetTaskExecution | [.flyteidl.admin.TaskExecutionGetRequest](#flyteidl.admin.TaskExecutionGetRequest) | [.flyteidl.admin.TaskExecution](#flyteidl.admin.TaskExecution) | | +| ListTaskExecutions | [.flyteidl.admin.TaskExecutionListRequest](#flyteidl.admin.TaskExecutionListRequest) | [.flyteidl.admin.TaskExecutionList](#flyteidl.admin.TaskExecutionList) | | +| GetTaskExecutionData | [.flyteidl.admin.TaskExecutionGetDataRequest](#flyteidl.admin.TaskExecutionGetDataRequest) | [.flyteidl.admin.TaskExecutionGetDataResponse](#flyteidl.admin.TaskExecutionGetDataResponse) | | +| UpdateProjectDomainAttributes | [.flyteidl.admin.ProjectDomainAttributesUpdateRequest](#flyteidl.admin.ProjectDomainAttributesUpdateRequest) | [.flyteidl.admin.ProjectDomainAttributesUpdateResponse](#flyteidl.admin.ProjectDomainAttributesUpdateResponse) | | +| GetProjectDomainAttributes | [.flyteidl.admin.ProjectDomainAttributesGetRequest](#flyteidl.admin.ProjectDomainAttributesGetRequest) | [.flyteidl.admin.ProjectDomainAttributesGetResponse](#flyteidl.admin.ProjectDomainAttributesGetResponse) | | +| DeleteProjectDomainAttributes | [.flyteidl.admin.ProjectDomainAttributesDeleteRequest](#flyteidl.admin.ProjectDomainAttributesDeleteRequest) | [.flyteidl.admin.ProjectDomainAttributesDeleteResponse](#flyteidl.admin.ProjectDomainAttributesDeleteResponse) | | +| UpdateWorkflowAttributes | [.flyteidl.admin.WorkflowAttributesUpdateRequest](#flyteidl.admin.WorkflowAttributesUpdateRequest) | [.flyteidl.admin.WorkflowAttributesUpdateResponse](#flyteidl.admin.WorkflowAttributesUpdateResponse) | | +| GetWorkflowAttributes | [.flyteidl.admin.WorkflowAttributesGetRequest](#flyteidl.admin.WorkflowAttributesGetRequest) | [.flyteidl.admin.WorkflowAttributesGetResponse](#flyteidl.admin.WorkflowAttributesGetResponse) | | +| DeleteWorkflowAttributes | [.flyteidl.admin.WorkflowAttributesDeleteRequest](#flyteidl.admin.WorkflowAttributesDeleteRequest) | [.flyteidl.admin.WorkflowAttributesDeleteResponse](#flyteidl.admin.WorkflowAttributesDeleteResponse) | | +| ListMatchableAttributes | [.flyteidl.admin.ListMatchableAttributesRequest](#flyteidl.admin.ListMatchableAttributesRequest) | [.flyteidl.admin.ListMatchableAttributesResponse](#flyteidl.admin.ListMatchableAttributesResponse) | | +| ListNamedEntities | [.flyteidl.admin.NamedEntityListRequest](#flyteidl.admin.NamedEntityListRequest) | [.flyteidl.admin.NamedEntityList](#flyteidl.admin.NamedEntityList) | | +| GetNamedEntity | [.flyteidl.admin.NamedEntityGetRequest](#flyteidl.admin.NamedEntityGetRequest) | [.flyteidl.admin.NamedEntity](#flyteidl.admin.NamedEntity) | | +| UpdateNamedEntity | [.flyteidl.admin.NamedEntityUpdateRequest](#flyteidl.admin.NamedEntityUpdateRequest) | [.flyteidl.admin.NamedEntityUpdateResponse](#flyteidl.admin.NamedEntityUpdateResponse) | | +| GetVersion | [.flyteidl.admin.GetVersionRequest](#flyteidl.admin.GetVersionRequest) | [.flyteidl.admin.GetVersionResponse](#flyteidl.admin.GetVersionResponse) | | + + + + + + +

Top

+ +## flyteidl/service/auth.proto + + + + + +### OAuth2MetadataRequest + + + + + + + + + +### OAuth2MetadataResponse +OAuth2MetadataResponse defines an RFC-Compliant response for /.well-known/oauth-authorization-server metadata +as defined in https://tools.ietf.org/html/rfc8414 + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| issuer | [string](#string) | | Defines the issuer string in all JWT tokens this server issues. The issuer can be admin itself or an external issuer. | +| authorization_endpoint | [string](#string) | | URL of the authorization server's authorization endpoint [RFC6749]. This is REQUIRED unless no grant types are supported that use the authorization endpoint. | +| token_endpoint | [string](#string) | | URL of the authorization server's token endpoint [RFC6749]. | +| response_types_supported | [string](#string) | repeated | Array containing a list of the OAuth 2.0 "response_type" values that this authorization server supports. | +| scopes_supported | [string](#string) | repeated | JSON array containing a list of the OAuth 2.0 [RFC6749] "scope" values that this authorization server supports. | +| token_endpoint_auth_methods_supported | [string](#string) | repeated | JSON array containing a list of client authentication methods supported by this token endpoint. | +| jwks_uri | [string](#string) | | URL of the authorization server's JWK Set [JWK] document. The referenced document contains the signing key(s) the client uses to validate signatures from the authorization server. | +| code_challenge_methods_supported | [string](#string) | repeated | JSON array containing a list of Proof Key for Code Exchange (PKCE) [RFC7636] code challenge methods supported by this authorization server. | +| grant_types_supported | [string](#string) | repeated | JSON array containing a list of the OAuth 2.0 grant type values that this authorization server supports. | + + + + + + + + +### PublicClientAuthConfigRequest + + + + + + + + + +### PublicClientAuthConfigResponse +FlyteClientResponse encapsulates public information that flyte clients (CLIs... etc.) can use to authenticate users. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| client_id | [string](#string) | | client_id to use when initiating OAuth2 authorization requests. | +| redirect_uri | [string](#string) | | redirect uri to use when initiating OAuth2 authorization requests. | +| scopes | [string](#string) | repeated | scopes to request when initiating OAuth2 authorization requests. | +| authorization_metadata_key | [string](#string) | | Authorization Header to use when passing Access Tokens to the server. If not provided, the client should use the default http `Authorization` header. | + + + + + + + + + + + + + + +### AuthMetadataService +The following defines an RPC service that is also served over HTTP via grpc-gateway. +Standard response codes for both are defined here: https://github.com/grpc-ecosystem/grpc-gateway/blob/master/runtime/errors.go +RPCs defined in this service must be anonymously accessible. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetOAuth2Metadata | [OAuth2MetadataRequest](#flyteidl.service.OAuth2MetadataRequest) | [OAuth2MetadataResponse](#flyteidl.service.OAuth2MetadataResponse) | Anonymously accessible. Retrieves local or external oauth authorization server metadata. | +| GetPublicClientConfig | [PublicClientAuthConfigRequest](#flyteidl.service.PublicClientAuthConfigRequest) | [PublicClientAuthConfigResponse](#flyteidl.service.PublicClientAuthConfigResponse) | Anonymously accessible. Retrieves the client information clients should use when initiating OAuth2 authorization requests. | + + + + + + +

Top

+ +## flyteidl/service/identity.proto + + + + + +### UserInfoRequest + + + + + + + + + +### UserInfoResponse +See the OpenID Connect spec at https://openid.net/specs/openid-connect-core-1_0.html#UserInfoResponse for more information. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| subject | [string](#string) | | Locally unique and never reassigned identifier within the Issuer for the End-User, which is intended to be consumed by the Client. | +| name | [string](#string) | | Full name | +| preferred_username | [string](#string) | | Shorthand name by which the End-User wishes to be referred to | +| given_name | [string](#string) | | Given name(s) or first name(s) | +| family_name | [string](#string) | | Surname(s) or last name(s) | +| email | [string](#string) | | Preferred e-mail address | +| picture | [string](#string) | | Profile picture URL | + + + + + + + + + + + + + + +### IdentityService +IdentityService defines an RPC Service that interacts with user/app identities. + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| UserInfo | [UserInfoRequest](#flyteidl.service.UserInfoRequest) | [UserInfoResponse](#flyteidl.service.UserInfoResponse) | Retrieves user information about the currently logged in user. | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | float | float | Float | +| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/flyteidl/protos/flyteidl/datacatalog/title.rst b/flyteidl/protos/flyteidl/datacatalog/title.rst deleted file mode 100644 index 76053195c5..0000000000 --- a/flyteidl/protos/flyteidl/datacatalog/title.rst +++ /dev/null @@ -1,8 +0,0 @@ -Flyte Data Catalog Service -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -These protos provide the interface definition for the Data Catalog Service. Data Catalog is a service for -indexing parameterized, strongly-typed data artifacts across revisions. It is used in the Flyte ecosystem -to catalog artifacts generated by task executions. Outputs generated by a task can be stored as artifact -data and tagged by the user so that it can be retrieved later by that tag. - diff --git a/flyteidl/protos/flyteidl/event/title.rst b/flyteidl/protos/flyteidl/event/title.rst deleted file mode 100644 index 5f126e5cdd..0000000000 --- a/flyteidl/protos/flyteidl/event/title.rst +++ /dev/null @@ -1,20 +0,0 @@ -############################################## -Flyte Internal and External Eventing interface -############################################## - -This section contains all the protocol buffer definitions for Internal and -External Eventing system. - -Flyte Internal Eventing -======================== - -This is the interface used by the dataplane (execution engine) to communicate -workflow and task progress back to the **control plane** admin service. - -Flyte External Eventing - Event Egress -======================================= - -This refers to the interface for all the event messages exiting from the Flyte -**control plane** and delivered on the configured pubsub channel. - - diff --git a/flyteidl/protos/flyteidl/service/title.rst b/flyteidl/protos/flyteidl/service/title.rst deleted file mode 100644 index 0376e96ade..0000000000 --- a/flyteidl/protos/flyteidl/service/title.rst +++ /dev/null @@ -1,6 +0,0 @@ -################################################### -REST and gRPC interface for the Flyte Admin Service -################################################### - -This section provides all endpoint defintions that are implemented by the Admin -service. diff --git a/flyteidl/protos/flyteidl/title.rst b/flyteidl/protos/flyteidl/title.rst deleted file mode 100644 index e0d58d33e0..0000000000 --- a/flyteidl/protos/flyteidl/title.rst +++ /dev/null @@ -1,7 +0,0 @@ -Flyte Language and API specification -==================================== - -The protocol buffers defined here provide a high level specification of various -entities in Flyte control plane and data plane. It provides detailed definition -and documentation of all these entities. - diff --git a/flyteidl/gen/pb-protodoc/flyteidl/index.rst b/flyteidl/protos/index.rst similarity index 74% rename from flyteidl/gen/pb-protodoc/flyteidl/index.rst rename to flyteidl/protos/index.rst index 71644fdd53..39544bcc2e 100644 --- a/flyteidl/gen/pb-protodoc/flyteidl/index.rst +++ b/flyteidl/protos/index.rst @@ -5,15 +5,14 @@ The protocol buffers defined here provide a high level specification of various entities in Flyte control plane and data plane. It provides detailed definition and documentation of all these entities. - .. toctree:: :maxdepth: 1 :caption: flyteidl :name: flyteidltoc - admin/index - core/index - datacatalog/index - event/index - plugins/index - service/index + docs/admin/index + docs/core/index + docs/datacatalog/index + docs/event/index + docs/plugins/index + docs/service/index