Skip to content

Commit 4f0bb1f

Browse files
committed
Initial commit
Signed-off-by: kvmw <[email protected]>
0 parents  commit 4f0bb1f

File tree

11 files changed

+479
-0
lines changed

11 files changed

+479
-0
lines changed

.github/workflows/ci.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: ci
2+
3+
on:
4+
push:
5+
branches: ['main']
6+
pull_request:
7+
branches: ['main']
8+
9+
jobs:
10+
check:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout
15+
uses: actions/checkout@v4
16+
17+
- name: Setup Python
18+
uses: actions/setup-python@v5
19+
with:
20+
python-version: '3.x'
21+
22+
- name: Install dependencies
23+
run: npm ci
24+
25+
- name: Check Lint
26+
run: npm run check

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.venv

LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

Procfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
web: gunicorn --bind 0.0.0.0:$PORT cook:app

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Config Server Python sample
2+
3+
![CI](https://github.com/spring-cloud-services-samples/cook-python/actions/workflows/ci.yml/badge.svg)
4+
5+
Sample Pyhton application demonstrating the use of Config Server in Tanzu Platform for Cloud Foundry.
6+
7+
For information on the Config Server product in Tanzu Platform for Cloud Foundry, please [see the documentation](https://techdocs.broadcom.com/us/en/vmware-tanzu/spring/spring-cloud-services-for-cloud-foundry/3-3/scs-tanzu/config-server-index.html).
8+
9+
## Building and Deploying
10+
11+
- Create a Config Server instance:
12+
13+
```
14+
cf create-service p.config-server standard cook-config-server -c '{ "git": { "uri": "https://github.com/spring-cloud-services-samples/cook-config" } }'
15+
```
16+
17+
- Install dependencies:
18+
19+
```
20+
pip install -r requirements.txt
21+
```
22+
23+
- Push the application:
24+
25+
```
26+
cf push
27+
```
28+
29+
## Trying It Out
30+
31+
Visit `[ROUTE]/restaurant`, where `[ROUTE]` is the route bound to the application. The "special" of the day will be taken from the configuration repository and the value of `cook.special`.
32+
33+
```
34+
$ curl https://cook.apps.example.cf-app.com/restaurant
35+
36+
Today's special is: Cake a la mode
37+
```

config_client.py

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
import os
2+
import requests
3+
import json
4+
from typing import Dict, Any, Optional
5+
from cfenv import AppEnv
6+
from oauth2 import OAuth2Client
7+
8+
class ConfigServerClient:
9+
def __init__(self):
10+
self.env = AppEnv()
11+
self.oauth_client = None
12+
self.credentials = None
13+
14+
# Get configuration parameters from environment variables
15+
self.name = os.getenv('APPLICATION_NAME', self.env.name)
16+
self.profiles = os.getenv('PROFILES', 'default')
17+
self.label = os.getenv('LABEL', 'main')
18+
19+
config_server = self.env.get_service(label="p.config-server")
20+
if not config_server:
21+
raise ValueError("The application is not bound to a 'p.config-server' service instance. Please bind and try again")
22+
23+
self.credentials = config_server.credentials
24+
self.oauth_client = OAuth2Client(
25+
client_id=self.credentials['client_id'],
26+
client_secret=self.credentials['client_secret'],
27+
access_token_uri=self.credentials['access_token_uri']
28+
)
29+
30+
def _makeHttpRequest(self, url: str, accept_type: str) -> requests.Response:
31+
"""Make an HTTP request to the config server with the specified accept type"""
32+
headers = {
33+
'Authorization': f"Bearer {self.oauth_client.get_access_token()}",
34+
'Accept': accept_type
35+
}
36+
37+
try:
38+
response = requests.get(url, headers=headers, timeout=30)
39+
response.raise_for_status()
40+
return response
41+
except requests.exceptions.RequestException as e:
42+
raise Exception(f"Http error: {str(e)}")
43+
44+
def load(self) -> Dict[str, Any]:
45+
"""Load and merge configuration properties from the config server"""
46+
url = f"{self.credentials['uri']}/{self.name}/{self.profiles}/{self.label}"
47+
48+
response = self._makeHttpRequest(url, 'application/json')
49+
50+
config = {}
51+
property_sources = response.json().get('propertySources', [])
52+
53+
for property_source in property_sources:
54+
config.update(property_source.get('source', {}))
55+
56+
return config
57+
58+
def loadTextResource(self, name: str) -> str:
59+
"""Load a text resource from the config server"""
60+
url = f"{self.credentials['uri']}/{self.name}/{self.profiles}/{self.label}/{name}"
61+
62+
response = self._makeHttpRequest(url, 'text/plain')
63+
return response.text
64+
65+
def loadBinaryResource(self, name: str) -> bytes:
66+
"""Load a binary resource from the config server"""
67+
url = f"{self.credentials['uri']}/{self.name}/{self.profiles}/{self.label}/{name}"
68+
69+
response = self._makeHttpRequest(url, 'application/octet-stream')
70+
return response.content

cook.py

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
import os
2+
from flask import Flask
3+
from config_client import ConfigServerClient
4+
5+
app = Flask(__name__)
6+
7+
config_client = ConfigServerClient()
8+
config = {}
9+
10+
def load_configuration():
11+
"""Load configuration from config server at startup"""
12+
global config
13+
try:
14+
config = config_client.load()
15+
print(f"Configuration loaded successfully")
16+
except Exception as e:
17+
print(f"Failed to load configuration: {str(e)}")
18+
raise e
19+
20+
# Load configuration at startup
21+
load_configuration()
22+
23+
@app.route('/restaurant')
24+
def restaurant():
25+
return f"Today's special is: {config.get('cook.special', 'none')}"
26+
27+
@app.route('/restaurant/secret-menu')
28+
def secret_menu():
29+
return f"{config.get('secretMenu', 'none')}"
30+
31+
@app.route('/restaurant/dessert-menu')
32+
def dessert_menu():
33+
return f"{config_client.loadTextResource('dessert.json')}"
34+
35+
if __name__ == '__main__':
36+
port = int(os.getenv("PORT", 8080))
37+
app.run(host='0.0.0.0', port=port)

env.example

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Copy this file to .env and modify values for your environment
2+
3+
# Application name
4+
APPLICATION_NAME=application
5+
6+
# Profiles
7+
PROFILES=default
8+
9+
# Label
10+
LABEL=main

0 commit comments

Comments
 (0)