oracle / oracle/coherence

Failing to list/create/delete caches through the REST API on Coherence v14.1.1.0

Open
#138 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Java
Stars
470
Forks
80
PR merge metrics
No merged PRs in 30d

Description

Describe the bug
Attempting to create/list/delete caches through the REST API results in 404 error code.

To Reproduce
I've installed this in my K8s cluster using the Coherence Kubernetes Operator as follows:

helm repo add coherence https://oracle.github.io/coherence-operator/charts
helm repo update
helm install  \
    --namespace coherence \
    coherence-operator \
    coherence/coherence-operator

apiVersion: coherence.oracle.com/v1
kind: Coherence
metadata:
  name: storage-cluster
spec:
  replicas: 3
  role: storage
  
  image: ghcr.io/oracle/coherence-ce:14.1.1-0-20
  
  # Coherence settings
  coherence:
    cacheConfig: /coherence/config/cache-config.xml
    localPort: 7575
    localPortAdjust: 7576
    metrics:
      enabled: true
      port: 9612
      ssl:
        enabled: false
    management:
      enabled: true
      port: 30000
      ssl:
        enabled: false

  # Mount the cache config
  configMapVolumes:
    - mountPath: /coherence/config
      name: cache-config

  # JVM settings
  jvm:
      memory:
        heapSize: 4g
      args:
        - "-XX:+UseG1GC"
        - "-XX:+AlwaysPreTouch"
        - "-Dcoherence.rest.config=/coherence/config/coherence-rest-config.xml"
        - "-Dcoherence.management=all"

  # Ports configuration
  ports:
    - name: management
      port: 30000
    - name: metrics
      port: 9612
      serviceMonitor:
        enabled: true
    - name: extend
      port: 20000
    - name: rest
      port: 8080

  # Container resources
  resources:
    requests:
      memory: "6Gi"
      cpu: "2"
    limits:
      memory: "8Gi"
      cpu: "4"

  # Volume claim for persistence
  volumeClaimTemplates:
    - metadata:
        name: storage
      spec:
        accessModes: ["ReadWriteOnce"]
        resources:
          requests:
            storage: 50Gi
        storageClassName: "gp3"

  # Pod management
  readinessProbe:
    initialDelaySeconds: 30
    periodSeconds: 10
  
  livenessProbe:
    initialDelaySeconds: 30
    periodSeconds: 10

  # Service monitoring annotations
  annotations:
    prometheus.io/scrape: "true"
    prometheus.io/port: "9612"

apiVersion: v1
kind: ConfigMap
metadata:
  name: cache-config
  namespace: coherence
data:
  cache-config.xml: |
    <?xml version="1.0"?>
    <cache-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                  xmlns="http://xmlns.oracle.com/coherence/coherence-cache-config"
                  xsi:schemaLocation="http://xmlns.oracle.com/coherence/coherence-cache-config coherence-cache-config.xsd">
      <caching-scheme-mapping>
        <cache-mapping>
          <cache-name>*</cache-name>
          <scheme-name>distributed-scheme</scheme-name>
        </cache-mapping>
      </caching-scheme-mapping>

      <caching-schemes>
        <distributed-scheme>
          <scheme-name>distributed-scheme</scheme-name>
          <service-name>PartitionedCache</service-name>
          <backing-map-scheme>
            <local-scheme/>
          </backing-map-scheme>
          <autostart>true</autostart>
        </distributed-scheme>

        <proxy-scheme>
          <service-name>ExtendHttpProxyService</service-name>
          <acceptor-config>
            <http-acceptor>
              <local-address>
                <address>localhost</address>
                <port>8080</port>
              </local-address>
            </http-acceptor>
          </acceptor-config>
          <autostart>true</autostart>
        </proxy-scheme>
      </caching-schemes>
    </cache-config>

  coherence-rest-config.xml: |
    <?xml version="1.0"?>
    <rest-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                 xmlns="http://xmlns.oracle.com/coherence/coherence-rest-config"
                 xsi:schemaLocation="http://xmlns.oracle.com/coherence/coherence-rest-config coherence-rest-config.xsd">
      <resources>
          <resource>
            <cache-name>*</cache-name>
            <key-class>java.lang.String</key-class>
            <value-class>example.Person</value-class>
            <direct-query enabled="true"/>
          </resource>
      </resources>
    </rest-config>

I've followed the configuration instructions from the following documentation:
https://docs.oracle.com/en/middleware/standalone/coherence/14.1.1.0/develop-remote-clients/building-your-first-coherence-rest-application.html#GUID-45D33C82-D9DA-455D-8691-FA341D86CF81
https://docs.oracle.com/en/middleware/standalone/coherence/14.1.1.0/develop-remote-clients/performing-grid-operations-rest.html#GUID-5C807FF2-5F0F-4F70-8665-1741BF7A22B0

Expected behaviour
I expect to successfully retrieve, create and delete the caches in the cluster through the REST API. Instead, I get the following:

~ $ curl -v -X PUT http://storage-cluster-rest:8080/api/dist-http-example/1 \
> -H "Content-Type: application/json" \
> -d '{"value": "test1"}'
* Host storage-cluster-rest:8080 was resolved.
* IPv6: (none)
* IPv4: 172.20.51.129
*   Trying 172.20.51.129:8080...
* Connected to storage-cluster-rest (172.20.51.129) port 8080
* using HTTP/1.x
> PUT /api/dist-http-example/1 HTTP/1.1
> Host: storage-cluster-rest:8080
> User-Agent: curl/8.12.1
> Accept: */*
> Content-Type: application/json
> Content-Length: 18
>
* upload completely sent off: 18 bytes
< HTTP/1.1 404 Not Found
< Date: Wed, 19 Feb 2025 09:15:56 GMT
< Content-length: 0
< X-content-type-options: nosniff
<
* Connection #0 to host storage-cluster-rest left intact
~ $ curl -v http://storage-cluster-rest:8080/api/dist-http-example/1.json
* Host storage-cluster-rest:8080 was resolved.
* IPv6: (none)
* IPv4: 172.20.51.129
*   Trying 172.20.51.129:8080...
* Connected to storage-cluster-rest (172.20.51.129) port 8080
* using HTTP/1.x
> GET /api/dist-http-example/1.json HTTP/1.1
> Host: storage-cluster-rest:8080
> User-Agent: curl/8.12.1
> Accept: */*
>
* Request completely sent off
< HTTP/1.1 404 Not Found
< Date: Wed, 19 Feb 2025 09:16:11 GMT
< Content-length: 0
< X-content-type-options: nosniff
<
* Connection #0 to host storage-cluster-rest left intact
~ $ curl -v http://storage-cluster-rest:8080/api/caches
* Host storage-cluster-rest:8080 was resolved.
* IPv6: (none)
* IPv4: 172.20.51.129
*   Trying 172.20.51.129:8080...
* Connected to storage-cluster-rest (172.20.51.129) port 8080
* using HTTP/1.x
> GET /api/caches HTTP/1.1
> Host: storage-cluster-rest:8080
> User-Agent: curl/8.12.1
> Accept: */*
>
* Request completely sent off
< HTTP/1.1 404 Not Found
< Date: Wed, 19 Feb 2025 09:16:15 GMT
< Content-length: 0
< X-content-type-options: nosniff
<
* Connection #0 to host storage-cluster-rest left intact

According to the logs, the acceptor is successfully listening for connections:

MacBook-Pro:~ georgecristiancimpoies$ kubectl logs storage-cluster-0 | grep -i acceptor
Defaulted container "coherence" out of: coherence, coherence-k8s-utils (init)
2025-02-19 09:09:55.849/5.541 Oracle Coherence CE 14.1.1.0.20 <Info> (thread=NameService:TcpAcceptor, member=n/a): TcpAcceptor now listening for connections on storage-cluster-0:7575.3
2025-02-19 09:09:56.371/6.062 Oracle Coherence CE 14.1.1.0.20 <Info> (thread=Proxy:ManagementHttpProxy:HttpAcceptor, member=1): HttpAcceptor now listening for connections on 0:0:0:0:0:0:0:0:30000
2025-02-19 09:09:56.932/6.623 Oracle Coherence CE 14.1.1.0.20 <Info> (thread=Proxy:ExtendHttpProxyService:HttpAcceptor, member=1): HttpAcceptor now listening for connections on 10.203.30.168:8080
2025-02-19 09:09:57.008/6.699 Oracle Coherence CE 14.1.1.0.20 <Info> (thread=Proxy:MetricsHttpProxy:HttpAcceptor, member=1): HttpAcceptor now listening for connections on 0:0:0:0:0:0:0:0:9612

Environment (please complete the following information):

  • Coherence CE version: 14.1.1-0-20
  • Java version and Java vendor: Not applicable
  • Environment: Kubernetes
    Client Version: v1.32.0
    Kustomize Version: v5.5.0
    Server Version: v1.29.12-eks-2d5f260

Additional context
Add any other context about the problem here.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Kubernetes deployment configuration and the coherence-rest-config.xml and cache-config.xml files shown in the report, then trace the REST entry point serving port 8080 and the /api endpoints. Reproduce the PUT and GET requests against the deployed service and determine why the configured cache resources are not exposed. Done means the documented list, create, and delete operations return successful responses instead of 404.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, kubernetes
Domain
api, backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.