Skip to content

Documentation fixes #747

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 21, 2025
Merged

Documentation fixes #747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1a0d02
Documentation fixes
thegridman May 16, 2025
d7fe423
More doc link fixes
thegridman May 20, 2025
ce123b8
Fix calico GitHub repo rate limiting
thegridman May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
183 changes: 0 additions & 183 deletions .github/workflows/release.yml
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2183,14 +2183,14 @@ kind-single-worker: ## Run a KinD cluster with a single worker node
# ----------------------------------------------------------------------------------------------------------------------
# Start a Kind cluster with Calico
# ----------------------------------------------------------------------------------------------------------------------
CALICO_VERSION ?= v3.25.0
CALICO_VERSION ?= v3.30.0

.PHONY: kind-calico
kind-calico: export KIND_CONFIG=$(KIND_SCRIPTS)/kind-config-calico.yaml
kind-calico: ## Run a KinD cluster with Calico
kind create cluster --name $(KIND_CLUSTER) --config $(KIND_SCRIPTS)/kind-config-calico.yaml --image $(KIND_IMAGE)
$(KIND_SCRIPTS)/kind-label-node.sh
$(KUBECTL_CMD) apply -f https://raw.githubusercontent.com/projectcalico/calico/$(CALICO_VERSION)/manifests/calico.yaml
$(KUBECTL_CMD) apply -f $(SCRIPTS_DIR)/calico/calico-$(CALICO_VERSION).yaml
$(KUBECTL_CMD) -n kube-system set env daemonset/calico-node FELIX_IGNORELOOSERPF=true
sleep 30
$(KUBECTL_CMD) -n kube-system wait --for condition=ready --timeout=$(CALICO_TIMEOUT) -l k8s-app=calico-node pod
Expand Down
24 changes: 12 additions & 12 deletions api/v1/coherence_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,16 +386,16 @@ type CloudNativeBuildPackSpec struct {
// ----- CoherenceSpec struct -----------------------------------------------

// CoherenceSpec is the section of the CRD configures settings specific to Coherence.
// +coh:doc=coherence_settings/010_overview.adoc,Coherence Configuration
// +coh:doc=docs/coherence_settings/010_overview.adoc,Coherence Configuration
// +k8s:openapi-gen=true
type CoherenceSpec struct {
// CacheConfig is the name of the cache configuration file to use
// +coh:doc=coherence_settings/030_cache_config.adoc,Configure Cache Config File
// +coh:doc=docs/coherence_settings/030_cache_config.adoc,Configure Cache Config File
// +optional
CacheConfig *string `json:"cacheConfig,omitempty"`
// OverrideConfig is name of the Coherence operational configuration override file,
// the default is tangosol-coherence-override.xml
// +coh:doc=coherence_settings/040_override_file.adoc,Configure Operational Config File
// +coh:doc=docs/coherence_settings/040_override_file.adoc,Configure Operational Config File
// +optional
OverrideConfig *string `json:"overrideConfig,omitempty"`
// A boolean flag indicating whether members of this deployment are storage enabled.
Expand All @@ -404,26 +404,26 @@ type CoherenceSpec struct {
// This flag is also used to configure the ScalingPolicy value if a value is not specified. If the
// StorageEnabled field is not specified or is true the scaling will be safe, if StorageEnabled is
// set to false scaling will be parallel.
// +coh:doc=coherence_settings/050_storage_enabled.adoc,Configure Storage Enabled
// +coh:doc=docs/coherence_settings/050_storage_enabled.adoc,Configure Storage Enabled
// +optional
StorageEnabled *bool `json:"storageEnabled,omitempty"`
// Persistence values configure the on-disc data persistence settings.
// The bool Enabled enables or disabled on disc persistence of data.
// +coh:doc=coherence_settings/080_persistence.adoc,Configure Persistence
// +coh:doc=docs/coherence_settings/080_persistence.adoc,Configure Persistence
// +optional
Persistence *PersistenceSpec `json:"persistence,omitempty"`
// The Coherence log level, default being 5 (info level).
// +coh:doc=coherence_settings/060_log_level.adoc,Configure Coherence log level
// +coh:doc=docs/coherence_settings/060_log_level.adoc,Configure Coherence log level
// +optional
LogLevel *int32 `json:"logLevel,omitempty"`
// Management configures Coherence management over REST
// Note: Coherence management over REST will is available in Coherence version >= 12.2.1.4.
// +coh:doc=management_and_diagnostics/010_overview.adoc,Management & Diagnostics
// +coh:doc=docs/management_and_diagnostics/010_overview.adoc,Management & Diagnostics
// +optional
Management *PortSpecWithSSL `json:"management,omitempty"`
// Metrics configures Coherence metrics publishing
// Note: Coherence metrics publishing will is available in Coherence version >= 12.2.1.4.
// +coh:doc=metrics/010_overview.adoc,Metrics
// +coh:doc=docs/metrics/010_overview.adoc,Metrics
// +optional
Metrics *PortSpecWithSSL `json:"metrics,omitempty"`
// Tracing is used to configure Coherence distributed tracing functionality.
Expand All @@ -442,13 +442,13 @@ type CoherenceSpec struct {
// +optional
AllowEndangeredForStatusHA []string `json:"allowEndangeredForStatusHA,omitempty"`
// Exclude members of this deployment from being part of the cluster's WKA list.
// +coh:doc=coherence_settings/070_wka.adoc,Well Known Addressing
// +coh:doc=docs/coherence_settings/070_wka.adoc,Well Known Addressing
// +optional
ExcludeFromWKA *bool `json:"excludeFromWKA,omitempty"`
// Specify an existing Coherence deployment to be used for WKA.
// If an existing deployment is to be used for WKA the ExcludeFromWKA is
// implicitly set to true.
// +coh:doc=coherence_settings/070_wka.adoc,Well Known Addressing
// +coh:doc=docs/coherence_settings/070_wka.adoc,Well Known Addressing
// +optional
WKA *CoherenceWKASpec `json:"wka,omitempty"`
// Certain features rely on a version check prior to starting the server, e.g. metrics requires >= 12.2.1.4.
Expand Down Expand Up @@ -2558,7 +2558,7 @@ type StartQuorumStatus struct {

// ConfigMapVolumeSpec represents a ConfigMap that will be added to the deployment's Pods as an
// additional Volume and as a VolumeMount in the containers.
// +coh:doc=misc_pod_settings/050_configmap_volumes.adoc,Add ConfigMap Volumes
// +coh:doc=docs/misc_pod_settings/050_configmap_volumes.adoc,Add ConfigMap Volumes
// +k8s:openapi-gen=true
type ConfigMapVolumeSpec struct {
// The name of the ConfigMap to mount.
Expand Down Expand Up @@ -2680,7 +2680,7 @@ func (in *ConfigMapVolumeSpec) AddVolumeMounts(c *corev1.Container) {

// SecretVolumeSpec represents a Secret that will be added to the deployment's Pods as an
// additional Volume and as a VolumeMount in the containers.
// +coh:doc=misc_pod_settings/020_secret_volumes.adoc,Add Secret Volumes
// +coh:doc=docs/misc_pod_settings/020_secret_volumes.adoc,Add Secret Volumes
// +k8s:openapi-gen=true
type SecretVolumeSpec struct {
// The name of the Secret to mount.
Expand Down
4 changes: 2 additions & 2 deletions api/v1/coherenceresourcespec_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,14 +122,14 @@ type CoherenceResourceSpec struct {
// A list of ConfigMaps to add as volumes.
// Each entry in the list will be added as a ConfigMap Volume to the deployment's
// Pods and as a VolumeMount to all the containers and init-containers in the Pod.
// +coh:doc=misc_pod_settings/050_configmap_volumes.adoc,Add ConfigMap Volumes
// +coh:doc=docs/misc_pod_settings/050_configmap_volumes.adoc,Add ConfigMap Volumes
// +listType=map
// +listMapKey=name
ConfigMapVolumes []ConfigMapVolumeSpec `json:"configMapVolumes,omitempty"`
// A list of Secrets to add as volumes.
// Each entry in the list will be added as a Secret Volume to the deployment's
// Pods and as a VolumeMount to all the containers and init-containers in the Pod.
// +coh:doc=misc_pod_settings/020_secret_volumes.adoc,Add Secret Volumes
// +coh:doc=docs/misc_pod_settings/020_secret_volumes.adoc,Add Secret Volumes
// +listType=map
// +listMapKey=name
SecretVolumes []SecretVolumeSpec `json:"secretVolumes,omitempty"`
Expand Down
2 changes: 1 addition & 1 deletion docs/about/01_overview.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Quick start guide to running your first Coherence cluster using the Coherence Op

[CARD]
.Install
[icon=fa-save,link=docs/installation/01_installation.adoc]
[icon=fa-save,link=docs/installation/001_installation.adoc]
--
Installing and running the Coherence Operator.
--
Expand Down
4 changes: 2 additions & 2 deletions docs/about/03_quickstart.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ to install a simple Coherence cluster.

== Prerequisites

Ensure that the <<docs/installation/01_installation.adoc,Coherence Operator prerequisites>> are available.
Ensure that the <<docs/installation/001_installation.adoc,Coherence Operator prerequisites>> are available.

== 1. Install the Coherence Operator

Expand Down Expand Up @@ -71,7 +71,7 @@ or with Helm v2
helm install --namespace coherence-test --name operator coherence/coherence-operator
----

See the <<docs/installation/01_installation.adoc, full install guide>> for more details.
See the <<docs/installation/001_installation.adoc, full install guide>> for more details.


== 2. Install a Coherence Deployment
Expand Down
Loading