Skip to content

Commit 93ecfab

Browse files
committed
Documentation and version fixes
1 parent 80793ec commit 93ecfab

File tree

2 files changed

+47
-49
lines changed

2 files changed

+47
-49
lines changed

ads/feature_store/docs/source/user_guides.setup.helm_chart.rst

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -80,17 +80,17 @@ __________________________________________________________
8080

8181
.. code-block:: yaml
8282
83-
db:
83+
db:
8484
configuredDB: MYSQL
8585
mysql:
8686
authType: BASIC
8787
basic:
8888
password: #enter-db-password-here
8989
jdbcURL: jdbc:mysql://<db-ip>:3306/FeatureStore?createDatabaseIfNotExist=true
9090
username: #enter-db-username-here
91-
imagePullSecrets:
92-
- name: #enter secret name containing docker secret here
93-
oci_meta:
91+
imagePullSecrets:
92+
- name: #enter secret name containing docker secret here
93+
oci_meta:
9494
images:
9595
repo: #ocir repo: <region-key>.ocir.io/<tenancy-namespace>/repository
9696
api:
@@ -99,91 +99,91 @@ __________________________________________________________
9999
authoriser:
100100
image: na
101101
tag: na
102-
102+
103103
104104
105105
- All available Helm values
106106

107107
.. code-block:: yaml
108108
109-
oci_meta:
110-
repo: #ocir repo: <region-key>.ocir.io/<tenancy-namespace>/repository
111-
images:
112-
api:
113-
image: #ocir image: The name of image
114-
tag: #API Image tag
115-
authoriser: # We don't want to deploy this image. This image will be deployed with OCI functions
116-
image: na
117-
tag: na
118-
119-
imagePullSecrets:
109+
oci_meta:
110+
repo: #ocir repo: <region-key>.ocir.io/<tenancy-namespace>/repository
111+
images:
112+
api:
113+
image: #ocir image: The name of image
114+
tag: #API Image tag
115+
authoriser: # We don't want to deploy this image. This image will be deployed with OCI functions
116+
image: na
117+
tag: na
118+
119+
imagePullSecrets:
120120
- name: #name-of-docker-secret-with-credentials
121121
122-
db:
123-
configuredDB: #type of DB configured. possible values: "MYSQL"
124-
mysql:
125-
authType: #Type of authentication to use for connecting to database.
126-
# Possible values: 'BASIC', 'VAULT'
127-
jdbcURL: #JDBC URL of the MySQL server
128-
username: #Name of the user on MySQL server
129-
basic:
130-
password: #Password to mysql server in plain-text format
131-
vault:
132-
vaultOcid: #OCID of the vault where the secret is kept
133-
secretName: #Name of the secret used for connecting to vault
122+
db:
123+
configuredDB: #Type of DB configured. Possible values: "MYSQL"
124+
mysql:
125+
authType: #Type of authentication to use for connecting to database.
126+
# Possible values: 'BASIC', 'VAULT'
127+
jdbcURL: #JDBC URL of the MySQL server
128+
username: #Name of the user on MySQL server
129+
basic:
130+
password: #Password to mysql server in plain-text format
131+
vault:
132+
vaultOcid: #OCID of the vault where the secret is kept
133+
secretName: #Name of the secret used for connecting to vault
134134
135-
resources: #https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
135+
resources: #https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
136136
137-
nameOverride: #Value for label app.kubernetes.io/name
137+
nameOverride: #Value for label app.kubernetes.io/name
138138
139-
podSecurityContext: #Pod security #https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
139+
podSecurityContext: #Pod security #https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
140140
141-
securityContext: #Container Security context #https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
141+
securityContext: #Container Security context #https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
142142
143-
deploymentStrategy: #This block is directly inserted into pod spec
143+
deploymentStrategy: #This block is directly inserted into pod spec
144144
#https://kubernetes.io/docs/concepts/workloads/controllers/deployment/
145145
146146
147-
nodeSelector: {} #Pod node selector
147+
nodeSelector: {} #Pod node selector
148148
#https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
149149
150-
tolerations: [] #Pod tolerations
150+
tolerations: [] #Pod tolerations
151151
#https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/
152152
153-
affinity: {} #Pod affinity
153+
affinity: {} #Pod affinity
154154
#https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/
155155
156-
replicaCount: #Pod replicas
156+
replicaCount: #Pod replicas
157157
#https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/
158158
159-
autoscaling: #Horizontal pod scaling details
159+
autoscaling: #Horizontal pod scaling details
160160
#https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/
161161
enabled:
162162
minReplicas:
163163
maxReplicas:
164164
targetCPUUtilizationPercentage:
165165
targetMemoryUtilizationPercentage:
166-
scaleUp:
166+
scaleUp:
167167
stabilizationWindowSeconds:
168168
periodSeconds:
169169
podCount:
170170
percentage:
171-
scaleDown:
171+
scaleDown:
172172
stabilizationWindowSeconds:
173173
periodSeconds:
174174
podCount:
175175
percentage:
176176
177-
applicationEnv:
178-
containerName: #Container name
177+
applicationEnv:
178+
containerName: #Container name
179179
180-
livenessProbe: # Liveness probe details
180+
livenessProbe: # Liveness probe details
181181
initialDelaySeconds:
182182
periodSeconds:
183183
timeoutSeconds:
184184
failureThreshold:
185185
186-
readinessProbe: # Readiness probe details
186+
readinessProbe: # Readiness probe details
187187
initialDelaySeconds:
188188
periodSeconds:
189189
timeoutSeconds:

ads/opctl/operator/lowcode/feature_store_marketplace/cmd.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,6 @@ def init(**kwargs: Dict) -> dict:
4848
"URL of the OCIR repository where the images will be cloned from marketplace \n"
4949
"(format: {region}.ocir.io/{tenancy_namespace}/{repository})",
5050
)
51-
ocir_image = click.prompt("OCIR image name", default="feature-store-api")
52-
5351
db_config: DBConfig = get_db_details()
5452

5553
print_heading(
@@ -58,7 +56,7 @@ def init(**kwargs: Dict) -> dict:
5856
prefix_newline_count=2,
5957
)
6058
helm_app_name = click.prompt("Helm app name", default="feature-store-api")
61-
kubernetes_namespace = click.prompt("Kubernetes namespace", default="feature-store")
59+
kubernetes_namespace = click.prompt("Kubernetes namespace", default="default")
6260
version = click.prompt(
6361
"Version of feature store stack to install",
6462
default=get_latest_listing_version(compartment_id),
@@ -72,8 +70,8 @@ def init(**kwargs: Dict) -> dict:
7270
"helm.appName": helm_app_name,
7371
"clusterDetails.namespace": kubernetes_namespace,
7472
"compartmentId": compartment_id,
75-
"ocirURL": f"{ocir_url.rstrip('/')}/{ocir_image}",
76-
"version": version,
73+
"ocirURL": f"{ocir_url.rstrip('/')}",
74+
"spec.version": version,
7775
"apiGatewayDeploymentDetails": api_gw_config.to_dict(),
7876
},
7977
required_keys=[],

0 commit comments

Comments
 (0)