latest
Installation
External Requirements
ZooKeeper
Statsd and Graphite
Install Nodepool
Configuration
Configuration
AWS EC2 Driver
Azure Compute Driver
Google Cloud Compute Engine (GCE) Driver
Kubernetes Driver
Openshift Driver
Openshift Pods Driver
OpenStack Driver
Static Driver
Metastatic Driver
Options
Operation
Nodepool-builder
Nodepool-launcher
Daemon usage
Metadata
Common Management Tasks
Image Management
Command Line Tools
Usage
dib-image-list
image-list
image-build
dib-image-delete
image-delete
list
delete
info
erase
alien-image-list
export-image-data
import-image-data
Removing a Provider
Removing from the Launcher
Removing from the Builder
Web interface
Monitoring
Nodepool builder
Nodepool launcher
Provider Metrics
Launch metrics
OpenStack API metrics
Developer’s Guide
Operation
Nodepool Builder
Drivers
Writing A New Provider Driver
ProviderConfig
Provider
NodeRequestHandler
TaskManager
Simple Drivers
State Machine Drivers
Release Notes
5.0.0
Prelude
4.4.0
New Features
4.3.0
New Features
4.2.2
Bug Fixes
4.2.1
Bug Fixes
4.2.0
Upgrade Notes
4.1.0
New Features
Upgrade Notes
4.0.0
Upgrade Notes
3.14.0
New Features
Upgrade Notes
3.13.1
Bug Fixes
3.13.0
New Features
Upgrade Notes
Bug Fixes
3.12.0
New Features
3.11.0
New Features
3.10.0
New Features
Bug Fixes
3.9.0
New Features
Upgrade Notes
3.8.0
New Features
3.7.1
Bug Fixes
3.7.0
New Features
3.6.0
Upgrade Notes
3.5.0
New Features
Known Issues
3.4.0
New Features
Upgrade Notes
Bug Fixes
3.3.1
New Features
Bug Fixes
3.3.0
New Features
Bug Fixes
3.2.0
New Features
Upgrade Notes
Bug Fixes
3.1.0
New Features
Upgrade Notes
Bug Fixes
3.0.1
New Features
Deprecation Notes
Nodepool
»
Index
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
Z
Symbols
:default: auto (attribute of providers.[openshiftpods].labels)
:type: str (attribute of providers.[openshiftpods].labels)
A
abstract (attribute of diskimages)
Adapter (class in nodepool.driver.statemachine)
alive_thread_count (nodepool.driver.NodeRequestHandler property)
arn (attribute of providers.[aws].pools.labels.iam-instance-profile)
auth-path (attribute of providers.[azure])
auto-floating-ip (attribute of providers.[openstack].pools)
availability-zones (attribute of providers.[openstack].pools)
aws (value of providers.driver)
azure (value of providers.driver)
B
backing-label (attribute of providers.[metastatic].pools.labels)
BaseTaskManagerProvider (class in nodepool.driver.taskmanager)
boot-from-volume (attribute of providers.[openstack].pools.labels)
boot-timeout (attribute of providers.[aws])
(attribute of providers.[azure])
(attribute of providers.[gce])
(attribute of providers.[openstack])
build-log-dir (attribute)
build-log-retention (attribute)
build-timeout (attribute of diskimages)
C
ca (attribute of zookeeper-tls)
cert (attribute of zookeeper-tls)
checkReusableNode() (nodepool.driver.NodeRequestHandler method)
chroot (attribute of zookeeper-servers)
clean-floating-ips (attribute of providers.[openstack])
cleanupLeakedResources() (nodepool.driver.Provider method)
cleanupNode() (nodepool.driver.Provider method)
cloud (attribute of providers.[openstack])
cloud-image (attribute of providers.[aws].pools.labels)
(attribute of providers.[azure].pools.labels)
(attribute of providers.[gce].pools.labels)
(attribute of providers.[openstack].pools.labels)
cloud-images (attribute of providers.[aws])
(attribute of providers.[azure])
(attribute of providers.[gce])
(attribute of providers.[openstack])
config-drive (attribute of providers.[openstack].cloud-images)
(attribute of providers.[openstack].diskimages)
connection-port (attribute of providers.[aws].cloud-images)
(attribute of providers.[azure].cloud-images)
(attribute of providers.[azure].diskimages)
(attribute of providers.[gce].cloud-images)
(attribute of providers.[openstack].cloud-images)
(attribute of providers.[openstack].diskimages)
(attribute of providers.[static].pools.nodes)
connection-type (attribute of providers.[aws].cloud-images)
(attribute of providers.[azure].cloud-images)
(attribute of providers.[azure].diskimages)
(attribute of providers.[gce].cloud-images)
(attribute of providers.[openstack].cloud-images)
(attribute of providers.[openstack].diskimages)
(attribute of providers.[static].pools.nodes)
console-log (attribute of providers.[openstack].pools.labels)
context (attribute of providers.[kubernetes])
(attribute of providers.[openshift])
(attribute of providers.[openshiftpods])
cpu (attribute of providers.[kubernetes].pools.labels)
(attribute of providers.[openshift].labels)
(attribute of providers.[openshiftpods].labels)
createInstance() (nodepool.driver.simple.SimpleTaskManagerAdapter method)
custom-data (attribute of providers.[azure].pools.labels)
D
deleteImage() (nodepool.driver.statemachine.Adapter method)
deleteInstance() (nodepool.driver.simple.SimpleTaskManagerAdapter method)
deleteResource() (nodepool.driver.statemachine.Adapter method)
dib-cmd (attribute of diskimages)
diskimage (attribute of providers.[azure].pools.labels)
(attribute of providers.[openstack].pools.labels)
diskimages (attribute of providers.[azure])
(attribute of providers.[openstack])
(attribute)
driver (attribute of providers)
Driver (class in nodepool.driver)
E
ebs-optimized (attribute of providers.[aws].pools.labels)
elements (attribute of diskimages)
elements-dir (attribute)
env (attribute of providers.[kubernetes].pools.labels)
(attribute of providers.[openshift].labels)
(attribute of providers.[openshiftpods].labels)
env-vars (attribute of diskimages)
F
flavor-name (attribute of providers.[openstack].pools.labels)
formats (attribute of diskimages)
G
gce (value of providers.driver)
generate-password (attribute of providers.[azure].cloud-images)
getAdapter() (nodepool.driver.simple.SimpleTaskManagerDriver method)
(nodepool.driver.statemachine.StateMachineDriver method)
getCreateStateMachine() (nodepool.driver.statemachine.Adapter method)
getDeleteStateMachine() (nodepool.driver.statemachine.Adapter method)
getProvider() (nodepool.driver.Driver method)
(nodepool.driver.simple.SimpleTaskManagerDriver method)
(nodepool.driver.statemachine.StateMachineDriver method)
getProviderConfig() (nodepool.driver.Driver method)
(nodepool.driver.simple.SimpleTaskManagerDriver method)
(nodepool.driver.statemachine.StateMachineDriver method)
getQuotaForLabel() (nodepool.driver.simple.SimpleTaskManagerAdapter method)
(nodepool.driver.statemachine.Adapter method)
getQuotaInformation() (nodepool.driver.simple.SimpleTaskManagerInstance method)
(nodepool.driver.statemachine.Instance method)
getQuotaLimits() (nodepool.driver.simple.SimpleTaskManagerAdapter method)
(nodepool.driver.statemachine.Adapter method)
getRequestHandler() (nodepool.driver.Provider method)
getSchema() (nodepool.driver.ProviderConfig method)
getSupportedLabels() (nodepool.driver.ProviderConfig method)
grace-time (attribute of providers.[metastatic].pools.labels)
H
hardware-profile (attribute of providers.[azure].pools.labels)
hasProviderQuota() (nodepool.driver.NodeRequestHandler method)
hasRemainingQuota() (nodepool.driver.NodeRequestHandler method)
host (attribute of zookeeper-servers)
host-key (attribute of providers.[static].pools.nodes)
host-key-checking (attribute of providers.[aws].pools)
(attribute of providers.[azure])
(attribute of providers.[azure].pools)
(attribute of providers.[gce].pools)
(attribute of providers.[openstack].pools)
(attribute of providers.[openstack].pools.labels)
(attribute of providers.[static].pools.nodes)
hostname-format (attribute of providers.[openstack])
I
iam-instance-profile (attribute of providers.[aws].pools.labels)
ignore-provider-quota (attribute of providers.[openstack].pools)
image (attribute of providers.[kubernetes].pools.labels)
(attribute of providers.[openshift].labels)
(attribute of providers.[openshiftpods].labels)
image-family (attribute of providers.[gce].cloud-images)
image-filter (attribute of providers.[azure].cloud-images)
image-filters (attribute of providers.[aws].cloud-images)
image-id (attribute of providers.[aws].cloud-images)
(attribute of providers.[azure].cloud-images)
(attribute of providers.[gce].cloud-images)
(attribute of providers.[openstack].cloud-images)
image-name (attribute of providers.[openstack].cloud-images)
image-name-format (attribute of providers.[openstack])
image-project (attribute of providers.[gce].cloud-images)
image-pull (attribute of providers.[kubernetes].pools.labels)
(attribute of providers.[openshift].labels)
(attribute of providers.[openshiftpods].labels)
image-reference (attribute of providers.[azure].cloud-images)
images-dir (attribute)
imagesAvailable() (nodepool.driver.NodeRequestHandler method)
Instance (class in nodepool.driver.statemachine)
instance-properties (attribute of providers.[openstack].pools.labels)
instance-type (attribute of providers.[aws].pools.labels)
(attribute of providers.[gce].pools.labels)
ipv4 (attribute of providers.[azure])
(attribute of providers.[azure].pools)
ipv6 (attribute of providers.[azure])
(attribute of providers.[azure].pools)
J
join() (nodepool.driver.Provider method)
K
key (attribute of providers.[azure].cloud-images)
(attribute of providers.[azure].diskimages)
(attribute of providers.[gce].cloud-images)
(attribute of zookeeper-tls)
key-name (attribute of providers.[aws].pools.labels)
(attribute of providers.[openstack].pools.labels)
kubernetes (value of providers.driver)
L
labelReady() (nodepool.driver.Provider method)
labels (attribute of providers.[aws].pools)
(attribute of providers.[azure].pools)
(attribute of providers.[gce].pools)
(attribute of providers.[kubernetes].pools)
(attribute of providers.[metastatic].pools)
(attribute of providers.[openshift])
(attribute of providers.[openshiftpods])
(attribute of providers.[openstack].pools)
(attribute of providers.[static].pools.nodes)
(attribute)
launch() (nodepool.driver.NodeRequestHandler method)
launch-retries (attribute of providers.[aws])
(attribute of providers.[azure])
(attribute of providers.[gce])
(attribute of providers.[kubernetes])
(attribute of providers.[openshift])
(attribute of providers.[openshiftpods])
(attribute of providers.[openstack])
launch-timeout (attribute of providers.[azure])
(attribute of providers.[openstack])
launchesComplete() (nodepool.driver.NodeRequestHandler method)
listen_address (attribute of webapp)
listInstances() (nodepool.driver.simple.SimpleTaskManagerAdapter method)
(nodepool.driver.statemachine.Adapter method)
listResources() (nodepool.driver.statemachine.Adapter method)
load() (nodepool.driver.ProviderConfig method)
(nodepool.driver.simple.SimpleTaskManagerInstance method)
location (attribute of providers.[azure])
(attribute of providers.[azure].cloud-images.image-filter)
M
main() (nodepool.driver.taskmanager.Task method)
manage_images (nodepool.driver.ProviderConfig property)
max-concurrency (attribute of providers)
max-cores (attribute of providers.[openstack].pools)
(attribute of tenant-resource-limits)
max-hold-age (attribute)
max-parallel-jobs (attribute of providers.[metastatic].pools.labels)
(attribute of providers.[static].pools.nodes)
max-pods (attribute of providers.[openshiftpods])
max-projects (attribute of providers.[openshift])
max-ram (attribute of providers.[openstack].pools)
(attribute of tenant-resource-limits)
max-ready-age (attribute of labels)
max-servers (attribute of providers.[metastatic].pools)
(attribute of providers.[openstack].pools)
(attribute of tenant-resource-limits)
memory (attribute of providers.[kubernetes].pools.labels)
(attribute of providers.[openshift].labels)
(attribute of providers.[openshiftpods].labels)
meta (attribute of providers.[openstack].diskimages)
min-ram (attribute of providers.[openstack].pools.labels)
min-ready (attribute of labels)
N
name (attribute of diskimages)
(attribute of labels)
(attribute of providers)
(attribute of providers.[aws])
(attribute of providers.[aws].cloud-images)
(attribute of providers.[aws].cloud-images.image-filters)
(attribute of providers.[aws].pools)
(attribute of providers.[aws].pools.labels)
(attribute of providers.[aws].pools.labels.iam-instance-profile)
(attribute of providers.[azure])
(attribute of providers.[azure].cloud-images)
(attribute of providers.[azure].cloud-images.image-filter)
(attribute of providers.[azure].diskimages)
(attribute of providers.[azure].pools)
(attribute of providers.[azure].pools.labels)
(attribute of providers.[gce])
(attribute of providers.[gce].cloud-images)
(attribute of providers.[gce].pools)
(attribute of providers.[gce].pools.labels)
(attribute of providers.[kubernetes].pools)
(attribute of providers.[kubernetes].pools.labels)
(attribute of providers.[kubernetes].pools.labels.env)
(attribute of providers.[metastatic])
(attribute of providers.[metastatic].pools)
(attribute of providers.[metastatic].pools.labels)
(attribute of providers.[openshift].labels)
(attribute of providers.[openshift].labels.env)
(attribute of providers.[openshift].pools)
(attribute of providers.[openshiftpods].labels)
(attribute of providers.[openshiftpods].labels.env)
(attribute of providers.[openshiftpods].pools)
(attribute of providers.[openstack].cloud-images)
(attribute of providers.[openstack].diskimages)
(attribute of providers.[openstack].pools)
(attribute of providers.[openstack].pools.labels)
(attribute of providers.[static].pools)
(attribute of providers.[static].pools.nodes)
namespace (value of providers.[kubernetes].pools.labels.type)
network (attribute of providers.[azure])
(attribute of providers.[azure].network)
networks (attribute of providers.[openstack].pools)
(attribute of providers.[openstack].pools.labels)
node-attributes (attribute of providers.[aws].pools)
(attribute of providers.[azure].pools)
(attribute of providers.[gce].pools)
(attribute of providers.[kubernetes].pools)
(attribute of providers.[openshift].pools)
(attribute of providers.[openshiftpods].pools)
(attribute of providers.[openstack].pools)
(attribute of providers.[static].pools)
node-selector (attribute of providers.[kubernetes].pools.labels)
(attribute of providers.[openshift].labels)
(attribute of providers.[openshiftpods].labels)
nodeDeletedNotification() (nodepool.driver.ProviderNotifications method)
nodepool-id (attribute of providers.[openstack])
nodepool.dib_image_build.<diskimage_name>.<ext>.size (stat)
nodepool.dib_image_build.<diskimage_name>.status.duration (stat)
nodepool.dib_image_build.<diskimage_name>.status.last_build (stat)
nodepool.dib_image_build.<diskimage_name>.status.rc (stat)
nodepool.image_update.<image name>.<provider name> (stat)
nodepool.label.<label>.nodes.<state> (stat)
nodepool.launch.<result> (stat)
nodepool.launch.image.<image>.<result> (stat)
nodepool.launch.provider.<provider>.<az>.<result> (stat)
nodepool.launch.requestor.<requestor>.<result> (stat)
nodepool.nodes.<state> (stat)
nodepool.provider.<provider>.leaked.floatingips (stat)
nodepool.provider.<provider>.leaked.instances (stat)
nodepool.provider.<provider>.leaked.ports (stat)
nodepool.provider.<provider>.max_servers (stat)
nodepool.provider.<provider>.nodes.<state> (stat)
nodepool.tenant_limits.<tenant>.<limit> (stat)
NodeRequestHandler (class in nodepool.driver)
NodeRequestHandlerNotifications (class in nodepool.driver)
nodeReusedNotification() (nodepool.driver.NodeRequestHandlerNotifications method)
nodes (attribute of providers.[static].pools)
O
offer (attribute of providers.[azure].cloud-images.image-reference)
openshift (value of providers.driver)
openshiftpods (value of providers.driver)
openstack (value of providers.driver)
P
parent (attribute of diskimages)
password (attribute of providers.[azure].cloud-images)
pause (attribute of diskimages)
(attribute of providers.[azure].diskimages)
(attribute of providers.[openstack].diskimages)
pod (value of providers.[kubernetes].pools.labels.type)
(value of providers.[openshift].labels.type)
pools (attribute of providers.[aws])
(attribute of providers.[azure])
(attribute of providers.[gce])
(attribute of providers.[kubernetes])
(attribute of providers.[metastatic])
(attribute of providers.[openshift])
(attribute of providers.[openshiftpods])
(attribute of providers.[openstack])
(attribute of providers.[static])
(nodepool.driver.ProviderConfig property)
port (attribute of webapp)
(attribute of zookeeper-servers)
port-cleanup-interval (attribute of providers.[openstack])
post-upload-hook (attribute of providers.[azure])
(attribute of providers.[openstack])
profile-name (attribute of providers.[aws])
project (value of providers.[openshift].labels.type)
Provider (class in nodepool.driver)
ProviderConfig (class in nodepool.driver)
ProviderNotifications (class in nodepool.driver)
providers (attribute)
providers.[aws] (attribute)
providers.[azure] (attribute)
providers.[gce] (attribute)
providers.[kubernetes] (attribute)
providers.[metastatic] (attribute)
providers.[openshift] (attribute)
providers.[openshiftpods] (attribute)
providers.[openstack] (attribute)
providers.[static] (attribute)
public-ip-address (attribute of providers.[aws].pools)
public-ipv4 (attribute of providers.[azure])
(attribute of providers.[azure].pools)
public-ipv6 (attribute of providers.[azure])
(attribute of providers.[azure].pools)
publisher (attribute of providers.[azure].cloud-images.image-reference)
python-path (attribute of diskimages)
(attribute of providers.[aws].cloud-images)
(attribute of providers.[azure].cloud-images)
(attribute of providers.[azure].diskimages)
(attribute of providers.[gce].cloud-images)
(attribute of providers.[kubernetes].pools.labels)
(attribute of providers.[openshift].labels)
(attribute of providers.[openshiftpods].labels)
(attribute of providers.[openstack].cloud-images)
(attribute of providers.[static].pools.nodes)
R
rate (attribute of providers.[azure])
(attribute of providers.[openstack])
rateLimit() (nodepool.driver.taskmanager.TaskManager method)
rebuild-age (attribute of diskimages)
region (attribute of providers.[gce])
region-name (attribute of providers.[aws])
(attribute of providers.[openstack])
release (attribute of diskimages)
reset() (nodepool.driver.Driver method)
resource-group (attribute of providers.[azure])
(attribute of providers.[azure].network)
resource-group-location (attribute of providers.[azure])
run() (nodepool.driver.NodeRequestHandler method)
S
security-group-id (attribute of providers.[aws].pools)
security-groups (attribute of providers.[openstack].pools)
setNodeMetadata() (nodepool.driver.NodeRequestHandler method)
shell-type (attribute of diskimages)
(attribute of providers.[aws].cloud-images)
(attribute of providers.[azure].cloud-images)
(attribute of providers.[gce].cloud-images)
(attribute of providers.[kubernetes].pools.labels)
(attribute of providers.[openshift].labels)
(attribute of providers.[openshiftpods].labels)
(attribute of providers.[openstack].cloud-images)
(attribute of providers.[static].pools.nodes)
SimpleTaskManagerAdapter (class in nodepool.driver.simple)
SimpleTaskManagerDriver (class in nodepool.driver.simple)
SimpleTaskManagerInstance (class in nodepool.driver.simple)
sku (attribute of providers.[azure].cloud-images.image-reference)
ssh (value of providers.[static].pools.nodes.connection-type)
start() (nodepool.driver.Provider method)
startNodeCleanup() (nodepool.driver.Provider method)
StateMachine (class in nodepool.driver.statemachine)
StateMachineDriver (class in nodepool.driver.statemachine)
static (value of providers.driver)
stop() (nodepool.driver.Provider method)
(nodepool.driver.taskmanager.TaskManager method)
submitTask() (nodepool.driver.taskmanager.TaskManager method)
subnet (attribute of providers.[azure].network)
subnet-id (attribute of providers.[aws].pools)
T
tags (attribute of providers.[aws].pools.labels)
(attribute of providers.[azure].cloud-images.image-filter)
(attribute of providers.[azure].pools.labels)
Task (class in nodepool.driver.taskmanager)
TaskManager (class in nodepool.driver.taskmanager)
tenant-name (attribute of tenant-resource-limits)
tenant-resource-limits (attribute)
timeout (attribute of providers.[static].pools.nodes)
type (attribute of providers.[kubernetes].pools.labels)
(attribute of providers.[openshift].labels)
U
unlockNodeSet() (nodepool.driver.NodeRequestHandler method)
uploadImage() (nodepool.driver.statemachine.Adapter method)
use-internal-ip (attribute of providers.[azure])
(attribute of providers.[azure].pools)
(attribute of providers.[gce].pools)
user-data (attribute of providers.[azure].pools.labels)
userdata (attribute of providers.[aws].pools.labels)
(attribute of providers.[openstack].pools.labels)
username (attribute of diskimages)
(attribute of providers.[aws].cloud-images)
(attribute of providers.[azure].cloud-images)
(attribute of providers.[azure].diskimages)
(attribute of providers.[gce].cloud-images)
(attribute of providers.[openstack].cloud-images)
(attribute of providers.[static].pools.nodes)
V
value (attribute of providers.[kubernetes].pools.labels.env)
(attribute of providers.[openshift].labels.env)
(attribute of providers.[openshiftpods].labels.env)
values (attribute of providers.[aws].cloud-images.image-filters)
version (attribute of providers.[azure].cloud-images.image-reference)
vm-size (attribute of providers.[azure].pools.labels.hardware-profile)
volume-size (attribute of providers.[aws].pools.labels)
(attribute of providers.[gce].pools.labels)
(attribute of providers.[openstack].pools.labels)
volume-type (attribute of providers.[aws].pools.labels)
(attribute of providers.[gce].pools.labels)
W
wait() (nodepool.driver.taskmanager.Task method)
waitForNodeCleanup() (nodepool.driver.Provider method)
webapp (attribute)
winrm (value of providers.[static].pools.nodes.connection-type)
Z
zone (attribute of providers.[gce])
zookeeper-servers (attribute)
zookeeper-tls (attribute)
Versions
v: latest
latest
5.0.0
4.4.0
4.3.0
4.2.2
4.2.1
4.2.0
4.1.0
4.0.0
3.14.0
3.13.1
3.13.0
3.12.0
3.11.0
3.10.0
3.9.0
3.8.0
3.7.1
3.7.0
3.6.0
3.5.0
3.4.0
3.3.1
3.3.0
3.2.0