Upgrading API Connect for GraphQL
IBM releases new versions of the API Connect for GraphQL Graph service operator as bugs are fixed and new features are implemented.
For best results, upgrade the operator regularly. Each new operator version installs a new version of the Graph service.
For OCP, substitute oc
for kubectl
in the following steps.
- Log in to your Kubernetes or OpenShift cluster.
- Change to the
stepzen
namespace. - Download and extract the newest CASE bundle from GitHub
at:
https://github.com/IBM/cloud-pak/tree/master/repo/case/ibm-stepzen-case
For detailed instructions on downloading and extracting the CASE bundle, see Installing API Connect Essentials.
- Refresh the Custom Resource Definition (CRD) by applying the newer version of the file:
Verify that the CRD has been successfully updated.kubectl apply -f crd.yaml
- Deploy the new
operator.
kubectl apply -f operator.yaml
- (Optional) Update the
cr.yaml
file.You can only update the CR if you updated the CRD and the sample
cr.yaml
file changed.If you want to change any of the settings in the CR, modify your current version of the file and then apply the changes by running the following command (for OCP, replace
kubectl
withoc
):kubectl apply -f cr.yaml
Alternatively, you can use
kubectl
to edit the existing CR and apply the spec changes to it:kubectl edit StepZenGraphServer stepzen
The example command assumes that your
cr.yaml
file CR hasname: stepzen
.For information on the settings available in the CR, see CR configuration settings.
- Verify that the operator is running with the following
command:
kubectl get StepZenGraphServer
If the upgrade completed successfully, you see a message similar to the following example, which indicates that the API Connect for GraphQL Graph service is running in your cluster:
NAME STATUS SUMMARY AGE stepzen Ready Services are ready 1m
- Run the following command to validate the version of operator and operand and also the check the
CR status history under the status. The final condition
should display the message “Services are
ready".
kubectl get graphserver -o yaml