Add help to Castellan Credential Factory Opts
This patch adds help documentation to the Castellan Credential
Factory Options when a configuration is generated.
Change-Id: I132923954ef70342eb31b048ff443d894988b320
Fernando Diaz
8 years ago
29 | 29 | |
30 | 30 | credential_opts = [ |
31 | 31 | # auth_type opt |
32 | cfg.StrOpt('auth_type', default=None), | |
32 | cfg.StrOpt('auth_type', default=None, | |
33 | help="The type of authentication credential to create. " | |
34 | "Possible values are 'token', 'password', 'keystone_token', " | |
35 | "and 'keystone_password'. Required if no context is passed to " | |
36 | "the credential factory."), | |
33 | 37 | |
34 | 38 | # token opt |
35 | cfg.StrOpt('token', default=None), | |
39 | cfg.StrOpt('token', default=None, | |
40 | help="Token for authentication. Required for 'token' and " | |
41 | "'keystone_token' auth_type if no context is passed to the " | |
42 | "credential factory."), | |
36 | 43 | |
37 | 44 | # password opts |
38 | cfg.StrOpt('username', default=None), | |
39 | cfg.StrOpt('password', default=None), | |
45 | cfg.StrOpt('username', default=None, | |
46 | help="Username for authentication. Required for 'password' " | |
47 | "auth_type. Optional for the 'keystone_password' auth_type."), | |
48 | cfg.StrOpt('password', default=None, | |
49 | help="Password for authentication. Required for 'password' and " | |
50 | "'keystone_password' auth_type."), | |
40 | 51 | |
41 | 52 | # keystone credential opts |
42 | cfg.StrOpt('user_id', default=None), | |
43 | cfg.StrOpt('user_domain_id', default=None), | |
44 | cfg.StrOpt('user_domain_name', default=None), | |
45 | cfg.StrOpt('trust_id', default=None), | |
46 | cfg.StrOpt('domain_id', default=None), | |
47 | cfg.StrOpt('domain_name', default=None), | |
48 | cfg.StrOpt('project_id', default=None), | |
49 | cfg.StrOpt('project_name', default=None), | |
50 | cfg.StrOpt('project_domain_id', default=None), | |
51 | cfg.StrOpt('project_domain_name', default=None), | |
52 | cfg.BoolOpt('reauthenticate', default=True) | |
53 | cfg.StrOpt('user_id', default=None, | |
54 | help="User ID for authentication. Optional for " | |
55 | "'keystone_token' and 'keystone_password' auth_type."), | |
56 | cfg.StrOpt('user_domain_id', default=None, | |
57 | help="User's domain ID for authentication. Optional for " | |
58 | "'keystone_token' and 'keystone_password' auth_type."), | |
59 | cfg.StrOpt('user_domain_name', default=None, | |
60 | help="User's domain name for authentication. Optional for " | |
61 | "'keystone_token' and 'keystone_password' auth_type."), | |
62 | cfg.StrOpt('trust_id', default=None, | |
63 | help="Trust ID for trust scoping. Optional for " | |
64 | "'keystone_token' and 'keystone_password' auth_type."), | |
65 | cfg.StrOpt('domain_id', default=None, | |
66 | help="Domain ID for domain scoping. Optional for " | |
67 | "'keystone_token' and 'keystone_password' auth_type."), | |
68 | cfg.StrOpt('domain_name', default=None, | |
69 | help="Domain name for domain scoping. Optional for " | |
70 | "'keystone_token' and 'keystone_password' auth_type."), | |
71 | cfg.StrOpt('project_id', default=None, | |
72 | help="Project ID for project scoping. Optional for " | |
73 | "'keystone_token' and 'keystone_password' auth_type."), | |
74 | cfg.StrOpt('project_name', default=None, | |
75 | help="Project name for project scoping. Optional for " | |
76 | "'keystone_token' and 'keystone_password' auth_type."), | |
77 | cfg.StrOpt('project_domain_id', default=None, | |
78 | help="Project's domain ID for project. Optional for " | |
79 | "'keystone_token' and 'keystone_password' auth_type."), | |
80 | cfg.StrOpt('project_domain_name', default=None, | |
81 | help="Project's domain name for project. Optional for " | |
82 | "'keystone_token' and 'keystone_password' auth_type."), | |
83 | cfg.BoolOpt('reauthenticate', default=True, | |
84 | help="Allow fetching a new token if the current one is " | |
85 | "going to expire. Optional for 'keystone_token' and " | |
86 | "'keystone_password' auth_type.") | |
53 | 87 | ] |
54 | 88 | |
55 | 89 | OPT_GROUP = 'key_manager' |