Browse Source

Add spec to drop creating admin endpoints

Change-Id: Ib94500235a04f3ec45066b7b26b2d925f4a37f6e
Jens Rosenboom 2 years ago
parent
commit
601a6fd07d
2 changed files with 136 additions and 0 deletions
  1. 9
    0
      doc/source/index.rst
  2. 127
    0
      specs/ocata/all/drop-admin-endpoints.rst

+ 9
- 0
doc/source/index.rst View File

@@ -4,6 +4,15 @@
4 4
 Specifications for the OpenStack Chef Project
5 5
 =============================================
6 6
 
7
+Ocata approved specs
8
+====================
9
+
10
+.. toctree::
11
+   :glob:
12
+   :maxdepth: 1
13
+
14
+   specs/ocata/**
15
+
7 16
 Liberty approved specs
8 17
 ======================
9 18
 

+ 127
- 0
specs/ocata/all/drop-admin-endpoints.rst View File

@@ -0,0 +1,127 @@
1
+..
2
+ This work is licensed under a Creative Commons Attribution 3.0 Unported
3
+ License.
4
+
5
+ http://creativecommons.org/licenses/by/3.0/legalcode
6
+
7
+=======================================================
8
+Stop generating admin endpoints in the keystone catalog
9
+=======================================================
10
+
11
+The admin endpoints offer no special functionality, users may talk to the
12
+public endpoints instead. The only historic use case has been the keystone
13
+v2 admin endpoint, but with keystone v3 API, even that is no longer needed.
14
+
15
+Problem description
16
+===================
17
+
18
+Currently we generate admin endpoints for almost all services. As the service
19
+catalog is sent to the API user for every transaction, this generates some
20
+amount of overhead, as these endpoints aren't really needed anymore. Dropping
21
+them will also reduce the time needed for chef runs.
22
+
23
+Proposed change
24
+===============
25
+
26
+Drop the admin endpoints from all identity_registration recipes in our
27
+cookbooks. This will affect:
28
+
29
+- cookbook-openstack-block-storage
30
+- cookbook-openstack-compute
31
+- cookbook-openstack-identity
32
+- cookbook-openstack-image
33
+- cookbook-openstack-networking
34
+- cookbook-openstack-orchestration
35
+- cookbook-openstack-telemetry
36
+
37
+Alternatives
38
+------------
39
+
40
+Stick to the status quo.
41
+
42
+Data model impact
43
+-----------------
44
+
45
+None
46
+
47
+REST API impact
48
+---------------
49
+
50
+None
51
+
52
+Security impact
53
+---------------
54
+
55
+Deployments that have been using a different admin endpoint with restricted
56
+access may need to switch to using the internal endpoint instead.
57
+
58
+Notifications impact
59
+--------------------
60
+
61
+None
62
+
63
+Other end user impact
64
+---------------------
65
+
66
+None
67
+
68
+Performance Impact
69
+------------------
70
+
71
+The size of the service catalog will be reduced, as well as the duration of
72
+chef runs, both with positively impact performance.
73
+
74
+Other deployer impact
75
+---------------------
76
+
77
+Deployments that in some way make unexpected use of the admin endpoints will
78
+need to be adapted.
79
+
80
+Developer impact
81
+----------------
82
+
83
+None
84
+
85
+
86
+Implementation
87
+==============
88
+
89
+Assignee(s)
90
+-----------
91
+
92
+Primary assignee:
93
+  <j-rosenboom-j>
94
+
95
+Other contributors:
96
+  <jklare>
97
+
98
+Work Items
99
+----------
100
+
101
+- Update identity_registration recipes
102
+- Check for unknown dependencies
103
+
104
+
105
+Dependencies
106
+============
107
+
108
+None
109
+
110
+
111
+Testing
112
+=======
113
+
114
+Our integration tests should have sufficient coverage in order to make sure
115
+that this change doesn't have any negative impact.
116
+
117
+
118
+Documentation Impact
119
+====================
120
+
121
+None
122
+
123
+
124
+References
125
+==========
126
+
127
+None

Loading…
Cancel
Save