k8s
▼
Project version
v2.6.2
v2.6.1
v2.6.0
v2.5.0
v2.4.2
v2.4.1
v2.4.0
v2.3.0
v2.2.0
v2.1.1
v2.1.0
v2.0.3
v2.0.2
v2.0.1
v2.0.0
v2.0.0-rc.6
v2.0.0-rc.5
v2.0.0-rc.4
v2.0.0-rc.3
v2.0.0-rc.2
v2.0.0-rc.1
v2.0.0-rc.0
v1.2.1
v1.2.0
v1.1.10
v1.1.9
v1.1.8
v1.1.7
v1.1.6
v1.1.5
v1.1.4
v1.1.3
v1.1.2
v1.1.1
v1.1.0
v1.0.0
v1.0.0-rc1
v0.5.2
v0.5.1
v0.5.0
v0.5.0-rc.2
v0.5.0-rc.1
v0.4.0
v0.3.2
v0.3.1
v0.3.0
v0.2.13
v0.2.12
v0.2.11
v0.2.10
v0.2.9
v0.2.8
v0.2.7
v0.2.6
v0.2.5
v0.2.4
v0.2.3
v0.2.2
v0.2.1
v0.2.0
v0.1.3
Pages
Modules
API Reference
Modules
K8s
Features
Installation
Usage
tl;dr Examples
Changelog
Unreleased
[2.6.2] - 2025-01-09
[2.6.1] - 2024-04-29
[2.6.0] - 2024-04-02
[2.5.0] - 2023-11-12
[2.4.2] - 2023-10-18
[2.4.1] - 2023-08-15
[2.4.0] - 2023-07-07
[2.3.0] - 2023-05-14
[2.2.0] - 2023-03-27
[2.1.1] - 2023-03-02
[2.1.0] - 2023-02-25
[2.0.3] - 2023-02-17
[2.0.2] - 2023-02-16
[2.0.1] - 2023-02-12
[2.0.0] - 2023-01-27
[2.0.0-rc.6] - 2023-01-19
[2.0.0-rc.5] - 2023-01-08
[2.0.0-rc.4] - 2023-01-07
[2.0.0-rc.3] - 2023-01-01
[2.0.0-rc.2] - 2022-12-31
[2.0.0-rc.1] - 2022-12-19
[2.0.0-rc.0] - 2022-12-14
[1.2.0] - 2022-12-07
[1.1.10] - 2022-10-30
[1.1.9] - 2022-10-28
[1.1.8] - 2022-10-26
[1.1.7] - 2022-10-15
[1.1.6] - 2022-10-03
[1.1.5] - 2022-05-19
[1.1.4] - 2022-03-15
[1.1.3] - 2022-03-13
[1.1.2] - 2022-03-13
[1.1.1] - 2022-03-01
[1.1.0] - 2022-02-21
[1.0.0] - 2021-07-19
[0.5.2] - 2020-07-31
[0.5.1] - 2020-07-17
[0.5.0] - 2020-02-12
[0.4.0] - 2019-08-29
[0.3.2] - 2019-08-15
[0.3.1] - 2019-08-15
[0.3.0] - 2019-07-29
[0.2.13] - 2019-06-27
[0.2.12] - 2019-06-26
[0.2.11] - 2019-06-24
[0.2.10] - 2019-06-24
[0.2.9] - 2019-06-10
Guides
Advanced
Custom Resource Definitions
Multiple Clusters
Performing sub-resource operations
Authentication (K8s.Conn.Auth)
Custom Authentication Providers
Using a Custom Authentication Provider
Connections (K8s.Conn)
Building Connections
Discovery (K8s.Discovery)
Using the Discovery module
Setting the Default Driver
Setting Drivers per Connection
Using the HTTP Driver (K8s.Discovery.Driver.HTTP)
Using the File Driver (K8s.Discovery.Driver.File)
Middleware (K8s.Middleware)
Changing a Connection's Middleware
Writing Middleware
Migrations
Migrating from < 2.0.0
Observability
Logging
Telemetry
Tracing
HTTP Operations (K8s.Operation)
Creating a Deployment from a Map
Creating a Deployment from a YAML File
Listing Deployments
Using labelSelector with List Operations
Getting a Deployment
Watch Operations (K8s.Client.Runner.Watch)
Wait on a Resource (K8s.Client.Runner.Wait)
Async Batch Operations (K8s.Client.Runner.Async)
List Operations as Elixir Streams (K8s.Client.Runner.Stream)
Connect to pods/exec subresource and execute commands
Connect to pods/log subresource to read logs from Pods
Testing
Mocking API Version and Resource Discovery
Mocking HTTP Responses of K8s.Operations in your application
Integration Testing
Usage
tl;dr Examples
K8s
Summary
Functions
default_cacertfile/0
default_discovery_driver/0
default_discovery_opts/0
default_http_provider/0
K8s.Client
Sections
Examples
Summary
Types
path_param/0
path_params/0
Functions
apply/2
apply/5
async/2
async/3
connect/4
create/1
create/2
create/4
delete/1
delete/3
delete_all/2
delete_all/3
get/1
get/3
list/3
parallel/3
patch/1
patch/2
patch/3
patch/5
put_conn/2
run/1
run/2
run/3
stream/1
stream/2
stream/3
stream_to/2
stream_to/3
stream_to/4
update/1
update/2
update/4
wait_until/2
wait_until/3
watch/3
K8s.Client.DynamicHTTPProvider
Summary
Functions
child_spec/1
list/0
locate/1
register/2
request/5
start_link/1
stream/5
stream_to/6
websocket_request/3
websocket_stream/3
websocket_stream_to/4
K8s.Client.HTTPStream
Summary
Types
to_lines_t/0
Functions
decode_json_objects/1
transform_to_lines/1
K8s.Client.HTTPTestHelper
Summary
Functions
render/1
render/2
stream_object/1
K8s.Client.Mint.ConnectionRegistry
Summary
Types
adapter_pool_t/0
adapter_type_t/0
uriopts/0
Functions
checkin/1
checkout/1
child_spec/1
start_link/1
K8s.Client.Mint.HTTPAdapter
Sections
Processes
State
Summary
Types
connection_args_t/0
t/0
Functions
child_spec/1
connection_args/2
open?/2
recv/2
request/7
start_link/1
websocket_request/5
websocket_send/3
K8s.Client.Mint.Request
Summary
Types
request_modes/0
t/0
Functions
map_frame/1
map_outgoing_frame/1
map_response/1
maybe_terminate_request/1
new/1
put_response/2
receive_upgrade_response/2
recv/2
stream_request_body/2
K8s.Client.MintHTTPProvider
K8s.Client.Provider
Summary
Types
error_t/0
headers/0
http_chunk_t/0
response_t/0
send_callback/0
stream_response_t/0
stream_success_t/0
stream_to_response_t/0
success_t/0
websocket_chunk_t/0
websocket_response_t/0
websocket_success_t/0
Callbacks
request/5
stream/5
stream_to/6
websocket_request/3
websocket_stream/3
websocket_stream_to/4
Functions
headers/1
K8s.Client.Runner.Async
Summary
Functions
run/3
K8s.Client.Runner.Base
Summary
Types
body_t/0
error_t/0
result_t/0
Functions
run/1
run/2
run/3
stream/3
stream_to/4
K8s.Client.Runner.Stream
Summary
Functions
run/1
run/2
run/3
K8s.Client.Runner.Stream.ListRequest
Summary
Types
continue_t/0
responses_t/0
t/0
Functions
next_item/1
stream/3
K8s.Client.Runner.Stream.Watch
Summary
Types
t/0
Functions
stream/3
K8s.Client.Runner.StreamTo
Summary
Functions
run/2
run/3
run/4
K8s.Client.Runner.Wait
Summary
Types
t/0
Functions
run/2
run/3
K8s.Conn
Sections
Example
Scenarios
Summary
Types
t/0
Functions
from_env/2
from_file/2
from_service_account/2
K8s.Conn.Auth
Summary
Callbacks
create/2
K8s.Conn.Auth.AuthProvider
Summary
Types
t/0
Functions
generate_token/1
K8s.Conn.Auth.Azure
Summary
Types
t/0
Functions
refresh_token/4
K8s.Conn.Auth.BasicAuth
Summary
Types
t/0
K8s.Conn.Auth.Certificate
Summary
Types
t/0
K8s.Conn.Auth.DigitalOcean
K8s.Conn.Auth.Exec
Summary
Types
t/0
K8s.Conn.Auth.ExecWorker.State
Summary
Types
t/0
K8s.Conn.Auth.ServiceAccount
Summary
Types
t/0
K8s.Conn.Auth.ServiceAccountWorker
Summary
Functions
child_spec/1
get_token/1
start_link/1
via_tuple/1
K8s.Conn.Auth.ServiceAccountWorker.State
Summary
Types
t/0
K8s.Conn.Auth.Token
Summary
Types
t/0
K8s.Conn.PKI
Summary
Types
private_key_data_t/0
Functions
cert_from_base64/1
cert_from_map/2
cert_from_pem/1
private_key_from_base64/1
private_key_from_pem/1
K8s.Conn.RequestOptions
Summary
Types
generate_t/0
t/0
Functions
generate/1
K8s.Discovery
Summary
Functions
default_driver/0
default_opts/0
resources/3
url_for/2
versions/2
K8s.Discovery.Driver
Summary
Types
driver_error_t/0
Callbacks
resources/2
resources/3
versions/1
versions/2
K8s.Discovery.Driver.File
Sections
Examples
K8s.Discovery.Driver.HTTP
K8s.Discovery.ResourceFinder
Summary
Types
error_t/0
Functions
find_resource/3
resource_name_for_kind/3
K8s.Middleware
Sections
Examples
Summary
Functions
run/2
K8s.Middleware.Error
Summary
Types
t/0
K8s.Middleware.Request
Summary
Types
t/0
Callbacks
call/1
K8s.Middleware.Request.EncodeBody
K8s.Middleware.Request.Initialize
K8s.Middleware.Stack
Summary
Types
t/0
Functions
default/0
K8s.Operation
Summary
Types
name_t/0
patch_type/0
t/0
Functions
build/3
build/6
get_label_selector/1
get_query_param/2
get_selector/1
put_conn/2
put_label_selector/2
put_query_param/2
put_query_param/3
put_selector/2
to_path/1
K8s.Operation.Path
Summary
Functions
build/1
find_params/1
replace_path_vars/2
K8s.Resource
Summary
Types
yaml_elixir_error_t/0
Functions
all_from_file/2
all_from_file!/2
annotation/2
annotations/1
api_version/1
build/2
build/3
build/4
build/5
cpu/1
from_file/2
from_file!/2
has_annotation?/2
has_label?/2
kind/1
label/2
labels/1
memory/1
metadata/1
name/1
namespace/1
K8s.Resource.FieldAccessors
Summary
Functions
annotation/2
annotations/1
api_version/1
has_annotation?/2
has_label?/2
kind/1
label/2
labels/1
metadata/1
name/1
namespace/1
K8s.Resource.NamedList
Summary
Functions
access/1
access!/1
K8s.Resource.Utilization
Summary
Functions
cpu/1
memory/1
K8s.Selector
Sections
Examples
Summary
Types
selector_or_operation_t/0
t/0
Functions
field/1
field/2
field_not/1
field_not/2
fields_to_s/1
label/1
label/2
label_does_not_exist/1
label_does_not_exist/2
label_exists/1
label_exists/2
label_in/1
label_in/2
label_not/1
label_not/2
label_not_in/1
label_not_in/2
labels_to_s/1
match_expression?/2
match_expressions?/2
match_label?/3
match_labels?/2
parse/1
serialize_match/1
serialize_match_expressions/1
serialize_match_labels/1
to_s/1
K8s.Sys.Event
Summary
Functions
events/0
K8s.Sys.Logger
Summary
Functions
attach/0
log_prefix/1
K8s.Sys.Telemetry
Summary
Functions
events/0
K8s.Version
Summary
Types
t/0
Functions
alpha/1
beta/1
edge/1
parse/1
recommended/1
serialize/1
sort/1
stable/1
Exceptions
K8s.Client.APIError
Summary
Types
t/0
Functions
from_kubernetes_error/1
K8s.Client.HTTPError
Summary
Types
t/0
Functions
from_exception/1
new/1
K8s.Conn.Error
Summary
Types
t/0
K8s.Discovery.Error
Summary
Types
t/0
K8s.Operation.Error
Summary
Types
t/0
Search documentation of k8s
Settings
View Source
K8s.Discovery.Driver.HTTP
(k8s v2.6.2)
HTTP Driver for Kubernetes API discovery
×